Class: Jamf::OAPISchemas::PlanStatus

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::PlanStatus

Defined in:

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

Overview

OAPI Object Model and Enums for: PlanStatus

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

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

[
  'Init',
  'PendingPlanValidation',
  'AcceptingPlan',
  'RejectingPlan',
  'ProcessingPlanType',
  'StartingPlan',
  'PlanFailed',
  'SchedulingScanForOSUpdates',
  'ProcessingScheduleOSUpdateScanResponse',
  'WaitingForScheduledOSUpdateScanToComplete',
  'CollectingAvailableOSUpdates',
  'ProcessingAvailableOSUpdatesResponse',
  'ProcessingSchedulingType',
  'SchedulingDDM',
  'DDMPlanScheduled',
  'WaitingToStartDDMUpdate',
  'ProcessingDDMStatusResponse',
  'CollectingDDMStatus',
  'SchedulingMDM',
  'MDMPlanScheduled',
  'SchedulingOSUpdate',
  'ProcessingScheduleOSUpdateResponse',
  'CollectingOSUpdateStatus',
  'ProcessingOSUpdateStatusResponse',
  'WaitingToCollectOSUpdateStatus',
  'VerifyingInstallation',
  'ProcessingInstallationVerification',
  'PlanCompleted',
  'PlanCanceled',
  'PlanException',
  'Unknown'
]

OAPI_PROPERTIES =

{

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

  # @!attribute [r] errorReasons
  #   @return [Array<String>]
  errorReasons: {
    class: :string,
    nil_ok: true,
    readonly: true,
    multi: true
  }

}

Instance Attribute Summary

• #errorReasons ⇒ Array<String> readonly
• #state ⇒ String readonly

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#errorReasons ⇒ Array<String> (readonly)

Returns:

• (Array<String>)

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

#state ⇒ String (readonly)

Returns:

• (String)

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