Class: Jamf::OAPISchemas::ManagedSoftwareUpdateStatus

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::ManagedSoftwareUpdateStatus

Defined in:

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

Overview

OAPI Object Model and Enums for: ManagedSoftwareUpdateStatus

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::ManagedSoftwareUpdateStatuses

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

STATUS_OPTIONS =

Enums used by this class or others

[
  'DOWNLOADING',
  'IDLE',
  'INSTALLING',
  'INSTALLED',
  'ERROR',
  'DOWNLOAD_FAILED',
  'DOWNLOAD_REQUIRES_COMPUTER',
  'DOWNLOAD_INSUFFICIENT_SPACE',
  'DOWNLOAD_INSUFFICIENT_POWER',
  'DOWNLOAD_INSUFFICIENT_NETWORK',
  'INSTALL_INSUFFICIENT_SPACE',
  'INSTALL_INSUFFICIENT_POWER',
  'INSTALL_PHONE_CALL_IN_PROGRESS',
  'INSTALL_FAILED',
  'UNKNOWN'
]

OAPI_PROPERTIES =

{

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

  # @!attribute device
  #   @return [Hash{Symbol: Object}]
  device: {
    class: :hash
  },

  # @!attribute downloadPercentComplete
  #   @return [Float]
  downloadPercentComplete: {
    class: :number
  },

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

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

  # @!attribute status
  #   @return [String]
  status: {
    class: :string,
    enum: STATUS_OPTIONS
  },

  # not applicable to all managed software update statuses
  # @!attribute deferralsRemaining
  #   @return [Integer]
  deferralsRemaining: {
    class: :integer
  },

  # not applicable to all managed software update statuses
  # @!attribute maxDeferrals
  #   @return [Integer]
  maxDeferrals: {
    class: :integer
  },

  # not applicable to all managed software update statuses
  # @!attribute nextScheduledInstall
  #   @return [Jamf::Timestamp]
  nextScheduledInstall: {
    class: Jamf::Timestamp,
    format: 'date-time'
  },

  # not applicable to all managed software update statuses
  # @!attribute pastNotifications
  #   @return [Array<Jamf::Timestamp>]
  pastNotifications: {
    class: Jamf::Timestamp,
    multi: true
  },

  # @!attribute created
  #   @return [Jamf::Timestamp]
  created: {
    class: Jamf::Timestamp,
    format: 'date-time'
  },

  # @!attribute updated
  #   @return [Jamf::Timestamp]
  updated: {
    class: Jamf::Timestamp,
    format: 'date-time'
  }

}

Instance Attribute Summary

• #created ⇒ Jamf::Timestamp
• #deferralsRemaining ⇒ Integer
• #device ⇒ Hash{Symbol: Object}
• #downloaded ⇒ Boolean
• #downloadPercentComplete ⇒ Float
• #maxDeferrals ⇒ Integer
• #nextScheduledInstall ⇒ Jamf::Timestamp
• #osUpdatesStatusId ⇒ String
• #pastNotifications ⇒ Array<Jamf::Timestamp>
• #productKey ⇒ String
• #status ⇒ String
• #updated ⇒ Jamf::Timestamp

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#created ⇒ Jamf::Timestamp

Returns:

• (Jamf::Timestamp)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_status.rb', line 154

#deferralsRemaining ⇒ Integer

Returns:

• (Integer)

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

#device ⇒ Hash{Symbol: Object}

Returns:

• (Hash{Symbol: Object})

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_status.rb', line 93

#downloaded ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_status.rb', line 105

#downloadPercentComplete ⇒ Float

Returns:

• (Float)

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

#maxDeferrals ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_status.rb', line 131

#nextScheduledInstall ⇒ Jamf::Timestamp

Returns:

• (Jamf::Timestamp)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_status.rb', line 138

#osUpdatesStatusId ⇒ String

Returns:

• (String)

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

#pastNotifications ⇒ Array<Jamf::Timestamp>

Returns:

• (Array<Jamf::Timestamp>)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_status.rb', line 146

#productKey ⇒ String

Returns:

• (String)

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

#status ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_status.rb', line 117

#updated ⇒ Jamf::Timestamp

Returns:

• (Jamf::Timestamp)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_status.rb', line 161