Class: Jamf::OAPISchemas::ManagedSoftwareUpdatePlan

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::ManagedSoftwareUpdatePlan

Defined in:

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

Overview

OAPI Object Model and Enums for: ManagedSoftwareUpdatePlan

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.

- Jamf::OAPISchemas::ManagedSoftwareUpdatePlans

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

- Jamf::OAPISchemas::PlanDevice
- Jamf::OAPISchemas::PlanStatus

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

- '/v1/managed-software-updates/plans/{id}:GET' needs permissions:
  - Read Managed Software Updates
  - Read Computers
  - Read Mobile Devices

Constant Summary

UPDATE_ACTION_OPTIONS =

Enums used by this class or others

[
  'DOWNLOAD_ONLY',
  'DOWNLOAD_INSTALL',
  'DOWNLOAD_INSTALL_ALLOW_DEFERRAL',
  'DOWNLOAD_INSTALL_RESTART',
  'DOWNLOAD_INSTALL_SCHEDULE',
  'UNKNOWN'
]

VERSION_TYPE_OPTIONS =

[
  'LATEST_MAJOR',
  'LATEST_MINOR',
  'LATEST_ANY',
  'SPECIFIC_VERSION',
  'UNKNOWN'
]

OAPI_PROPERTIES =

{

  # @!attribute [r] planUuid
  #   @return [String]
  planUuid: {
    class: :string,
    required: true,
    readonly: true,
    min_length: 1
  },

  # @!attribute device
  #   @return [Jamf::OAPISchemas::PlanDevice]
  device: {
    class: Jamf::OAPISchemas::PlanDevice,
    required: true
  },

  # @!attribute [r] updateAction
  #   @return [String]
  updateAction: {
    class: :string,
    required: true,
    readonly: true,
    enum: UPDATE_ACTION_OPTIONS
  },

  # @!attribute [r] versionType
  #   @return [String]
  versionType: {
    class: :string,
    required: true,
    readonly: true,
    enum: VERSION_TYPE_OPTIONS
  },

  # Optional. Indicates the specific version to update to. Only available when the version type is set to specific version, otherwise defaults to NO_SPECIFIC_VERSION.
  # @!attribute [r] specificVersion
  #   @return [String]
  specificVersion: {
    class: :string,
    readonly: true
  },

  # Not applicable to all managed software update plans
  # @!attribute [r] maxDeferrals
  #   @return [Integer]
  maxDeferrals: {
    class: :integer,
    required: true,
    readonly: true,
    minimum: 0
  },

  # Optional. Indicates the local date and time of the device to force update by.
  # @!attribute forceInstallLocalDateTime
  #   @return [String]
  forceInstallLocalDateTime: {
    class: Jamf::Timestamp,
    nil_ok: true
  },

  # The id of the recipe that was used to generate the plan.
  # @!attribute [r] recipeId
  #   @return [String]
  recipeId: {
    class: :string,
    readonly: true
  },

  # @!attribute status
  #   @return [Jamf::OAPISchemas::PlanStatus]
  status: {
    class: Jamf::OAPISchemas::PlanStatus,
    required: true
  }

}

Instance Attribute Summary

• #device ⇒ Jamf::OAPISchemas::PlanDevice
• #forceInstallLocalDateTime ⇒ String
• #maxDeferrals ⇒ Integer readonly
• #planUuid ⇒ String readonly
• #recipeId ⇒ String readonly
• #specificVersion ⇒ String readonly
• #status ⇒ Jamf::OAPISchemas::PlanStatus
• #updateAction ⇒ String readonly
• #versionType ⇒ String readonly

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#device ⇒ Jamf::OAPISchemas::PlanDevice

Returns:

• (Jamf::OAPISchemas::PlanDevice)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_plan.rb', line 99

#forceInstallLocalDateTime ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_plan.rb', line 142

#maxDeferrals ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_plan.rb', line 132

#planUuid ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_plan.rb', line 90

#recipeId ⇒ String (readonly)

Returns:

• (String)

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

#specificVersion ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_plan.rb', line 124

#status ⇒ Jamf::OAPISchemas::PlanStatus

Returns:

• (Jamf::OAPISchemas::PlanStatus)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_plan.rb', line 158

#updateAction ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_plan.rb', line 106

#versionType ⇒ String (readonly)

Returns:

• (String)

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