Class: Jamf::OAPISchemas::PlanConfigurationPost

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::PlanConfigurationPost

Defined in:

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

Overview

OAPI Object Model and Enums for: PlanConfigurationPost

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::ManagedSoftwareUpdatePlanGroupPost
- Jamf::OAPISchemas::ManagedSoftwareUpdatePlanPost

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

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

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 updateAction
  #   @return [String]
  updateAction: {
    class: :string,
    required: true,
    enum: UPDATE_ACTION_OPTIONS
  },

  # @!attribute versionType
  #   @return [String]
  versionType: {
    class: :string,
    required: 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 specificVersion
  #   @return [String]
  specificVersion: {
    class: :string,
    min_length: 0
  },

  # Required when the provided updateAction is DOWNLOAD_INSTALL_ALLOW_DEFERRAL, not applicable to all managed software update plans
  # @!attribute maxDeferrals
  #   @return [Integer]
  maxDeferrals: {
    class: :integer,
    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
  }

}

Instance Attribute Summary

• #forceInstallLocalDateTime ⇒ String
• #maxDeferrals ⇒ Integer
• #specificVersion ⇒ String
• #updateAction ⇒ String
• #versionType ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#forceInstallLocalDateTime ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/plan_configuration_post.rb', line 119

#maxDeferrals ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/plan_configuration_post.rb', line 111

#specificVersion ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/plan_configuration_post.rb', line 103

#updateAction ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/plan_configuration_post.rb', line 87

#versionType ⇒ String

Returns:

• (String)

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