Class: Jamf::OAPISchemas::DeploymentTask

Inherits:
Jamf::OAPIObject show all
Defined in:
lib/jamf/api/jamf_pro/oapi_schemas/deployment_task.rb

Overview

OAPI Object Model and Enums for: DeploymentTask

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

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 collapse

STATUS_OPTIONS =

Enums used by this class or others

[
  'COMMAND_QUEUED',
  'NO_COMMAND',
  'PENDING_MANIFEST',
  'COMPLETE',
  'GAVE_UP',
  'UNKNOWN'
]
OAPI_PROPERTIES = 
{

  # @!attribute [r] id
  #   @return [String]
  id: {
    class: :j_id,
    identifier: :primary,
    readonly: true
  },

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

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

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

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

  # Status of this Jamf Connect deployment task. "Command" below refers to an `InstallEnterpriseApplication` command. Tasks that are not finished (i.e., `COMPLETE` or `GAVE_UP`) are evaluated once every thirty minutes, so the status value for a device may lag behind a successful Jamf Connect package install up to thirty minutes. * `COMMAND_QUEUED` - command has been queued * `NO_COMMAND` - command has not yet been queued * `PENDING_MANIFEST` - task is waiting to obtain a valid package manifest before a command can be queued * `COMPLETE` - command has been completed successfully * `GAVE_UP` - the command failed with an error or the device did not process it in a reasonable amount of time * `UNKNOWN` - unknown; tasks in this state will be evaluated
  # @!attribute status
  #   @return [String]
  status: {
    class: :string,
    enum: STATUS_OPTIONS
  }

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#computerId ⇒ String (readonly)

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/deployment_task.rb', line 86

#computerName ⇒ String (readonly)

Returns:




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

#id ⇒ String (readonly)

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/deployment_task.rb', line 78

#status ⇒ String

Returns:




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

#updated ⇒ Jamf::Timestamp (readonly)

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/deployment_task.rb', line 107

#version ⇒ String (readonly)

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/deployment_task.rb', line 100