Class: Jamf::OAPISchemas::ManagedSoftwareUpdatePlanToggleStatus

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::ManagedSoftwareUpdatePlanToggleStatus

Defined in:

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

Overview

OAPI Object Model and Enums for: ManagedSoftwareUpdatePlanToggleStatus

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::ManagedSoftwareUpdatePlanToggleStatusWrapper
- Jamf::OAPISchemas::ManagedSoftwareUpdatePlanToggleStatusWrapper

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

STATE_OPTIONS =

Enums used by this class or others

[
  'NOT_RUNNING',
  'RUNNING',
  'NEVER_RAN'
]

EXIT_STATE_OPTIONS =

[
  'UNKNOWN',
  'EXECUTING',
  'COMPLETED',
  'NOOP',
  'FAILED',
  'STOPPED'
]

OAPI_PROPERTIES =

{

  # The local server time when the toggle was initiated. Null if state is NEVER_RAN
  # @!attribute startTime
  #   @return [String]
  startTime: {
    class: Jamf::Timestamp,
    nil_ok: true
  },

  # The local server time when the toggle was completed. Null if state is NEVER_RAN
  # @!attribute endTime
  #   @return [String]
  endTime: {
    class: Jamf::Timestamp,
    nil_ok: true
  },

  # Duration in seconds between the start time and end time. "Now" is used when end time is null. Null if state is NEVER_RAN
  # @!attribute elapsedTime
  #   @return [Integer]
  elapsedTime: {
    class: :integer,
    nil_ok: true
  },

  # The current state of the toggle
  # @!attribute state
  #   @return [String]
  state: {
    class: :string,
    enum: STATE_OPTIONS
  },

  # The total number of records that will be deleted
  # @!attribute totalRecords
  #   @return [Integer]
  totalRecords: {
    class: :integer,
    format: 'int64'
  },

  # The total number of records that have been deleted
  # @!attribute processedRecords
  #   @return [Integer]
  processedRecords: {
    class: :integer,
    format: 'int64'
  },

  # The percentage between total and completed records.
  # @!attribute percentComplete
  #   @return [Float]
  percentComplete: {
    class: :number,
    format: 'double'
  },

  # Pretty print of total, processed, and percentage complete
  # @!attribute formattedPercentComplete
  #   @return [String]
  formattedPercentComplete: {
    class: :string
  },

  # Troubleshooting - The exit status code from the toggle processing job. "Unknown" will return when the toggle is running.
  # @!attribute exitState
  #   @return [String]
  exitState: {
    class: :string,
    enum: EXIT_STATE_OPTIONS
  },

  # Troubleshooting - The exit message of the toggle job if it encounters an exception while running. Nominal return is an empty string
  # @!attribute exitMessage
  #   @return [String]
  exitMessage: {
    class: :string
  }

}

Instance Attribute Summary

• #elapsedTime ⇒ Integer
• #endTime ⇒ String
• #exitMessage ⇒ String
• #exitState ⇒ String
• #formattedPercentComplete ⇒ String
• #percentComplete ⇒ Float
• #processedRecords ⇒ Integer
• #startTime ⇒ String
• #state ⇒ String
• #totalRecords ⇒ Integer

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#elapsedTime ⇒ Integer

Returns:

• (Integer)

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

#endTime ⇒ String

Returns:

• (String)

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

#exitMessage ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_plan_toggle_status.rb', line 156

#exitState ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_plan_toggle_status.rb', line 148

#formattedPercentComplete ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_plan_toggle_status.rb', line 141

#percentComplete ⇒ Float

Returns:

• (Float)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_plan_toggle_status.rb', line 133

#processedRecords ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_plan_toggle_status.rb', line 125

#startTime ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_plan_toggle_status.rb', line 85

#state ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/managed_software_update_plan_toggle_status.rb', line 109

#totalRecords ⇒ Integer

Returns:

• (Integer)

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