Class: Jamf::OAPISchemas::PatchSoftwareTitleConfigurationBase

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::PatchSoftwareTitleConfigurationBase

Defined in:

lib/jamf/api/jamf_pro/oapi_schemas/patch_software_title_configuration_base.rb

Overview

OAPI Object Model and Enums for: PatchSoftwareTitleConfigurationBase

This class was automatically generated from the api/schema URL path on a Jamf Pro server version 11.6.1-t1718634702

This class may be used directly, e.g instances of other classes may use instances of this class as one of their own properties/attributes.

It may also be used as a superclass when implementing Jamf Pro API Resources in ruby-jss. The subclasses include appropriate mixins, and should expand on the basic functionality provided here.

Container Objects: Other object models that use this model as the value in one of their attributes.

Sub Objects: Other object models used by this model’s attributes.

- Jamf::OAPISchemas::PatchSoftwareTitleConfigurationExtensionAttributes

Endpoints and Privileges: API endpoints and HTTP operations that use this object model, and the Jamf Pro privileges needed to access them.

- '/v2/patch-software-title-configurations:POST' needs permissions:
  - Create Patch Management Software Titles

Constant Summary

OAPI_PROPERTIES =

{

  # @!attribute displayName
  #   @return [String]
  displayName: {
    class: :string,
    required: true
  },

  # @!attribute categoryId
  #   @return [String]
  categoryId: {
    class: :string
  },

  # @!attribute siteId
  #   @return [String]
  siteId: {
    class: :string
  },

  # @!attribute uiNotifications
  #   @return [Boolean]
  uiNotifications: {
    class: :boolean
  },

  # @!attribute emailNotifications
  #   @return [Boolean]
  emailNotifications: {
    class: :boolean
  },

  # @!attribute softwareTitleId
  #   @return [String]
  softwareTitleId: {
    class: :string,
    required: true
  },

  # @!attribute [r] jamfOfficial
  #   @return [Boolean]
  jamfOfficial: {
    class: :boolean,
    readonly: true
  },

  # @!attribute extensionAttributes
  #   @return [Array<Jamf::OAPISchemas::PatchSoftwareTitleConfigurationExtensionAttributes>]
  extensionAttributes: {
    class: Jamf::OAPISchemas::PatchSoftwareTitleConfigurationExtensionAttributes,
    multi: true
  },

  # @!attribute [r] softwareTitleName
  #   @return [String]
  softwareTitleName: {
    class: :string,
    readonly: true
  },

  # @!attribute [r] softwareTitleNameId
  #   @return [String]
  softwareTitleNameId: {
    class: :string,
    readonly: true
  },

  # @!attribute [r] softwareTitlePublisher
  #   @return [String]
  softwareTitlePublisher: {
    class: :string,
    readonly: true
  },

  # @!attribute [r] patchSourceName
  #   @return [String]
  patchSourceName: {
    class: :string,
    readonly: true
  },

  # @!attribute [r] patchSourceEnabled
  #   @return [Boolean]
  patchSourceEnabled: {
    class: :boolean,
    readonly: true
  }

}

Instance Attribute Summary

• #categoryId ⇒ String
• #displayName ⇒ String
• #emailNotifications ⇒ Boolean
• #extensionAttributes ⇒ Array<Jamf::OAPISchemas::PatchSoftwareTitleConfigurationExtensionAttributes>
• #jamfOfficial ⇒ Boolean readonly
• #patchSourceEnabled ⇒ Boolean readonly
• #patchSourceName ⇒ String readonly
• #siteId ⇒ String
• #softwareTitleId ⇒ String
• #softwareTitleName ⇒ String readonly
• #softwareTitleNameId ⇒ String readonly
• #softwareTitlePublisher ⇒ String readonly
• #uiNotifications ⇒ Boolean

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#categoryId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/patch_software_title_configuration_base.rb', line 77

#displayName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/patch_software_title_configuration_base.rb', line 70

#emailNotifications ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/patch_software_title_configuration_base.rb', line 95

#extensionAttributes ⇒ Array<Jamf::OAPISchemas::PatchSoftwareTitleConfigurationExtensionAttributes>

Returns:

• (Array<Jamf::OAPISchemas::PatchSoftwareTitleConfigurationExtensionAttributes>)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/patch_software_title_configuration_base.rb', line 115

#jamfOfficial ⇒ Boolean (readonly)

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/patch_software_title_configuration_base.rb', line 108

#patchSourceEnabled ⇒ Boolean (readonly)

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/patch_software_title_configuration_base.rb', line 150

#patchSourceName ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/patch_software_title_configuration_base.rb', line 143

#siteId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/patch_software_title_configuration_base.rb', line 83

#softwareTitleId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/patch_software_title_configuration_base.rb', line 101

#softwareTitleName ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/patch_software_title_configuration_base.rb', line 122

#softwareTitleNameId ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/patch_software_title_configuration_base.rb', line 129

#softwareTitlePublisher ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/patch_software_title_configuration_base.rb', line 136

#uiNotifications ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/patch_software_title_configuration_base.rb', line 89