Class: Jamf::OAPISchemas::PatchPolicySummary

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::PatchPolicySummary

Defined in:

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

Overview

OAPI Object Model and Enums for: PatchPolicySummary

This class was automatically genereated from the api/schema URL path on a Jamf Pro server version 10.36.1-t1645562643

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

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.

- '/patch/obj/policy/{id}:GET' needs permissions:
  - Read Patch Policies
- '/patch/objs/policy/{id}:GET' needs permissions:
  - Read Patch Policies
- '/patch/patch-policies:GET' needs permissions:
  - Read Patch Policies

Constant Summary

OAPI_PROPERTIES =

{

  # @!attribute policyId
  #   @return [Integer]
  policyId: {
    class: :integer
  },

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

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

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

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

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

  # @!attribute softwareTitleConfigurationId
  #   @return [Integer]
  softwareTitleConfigurationId: {
    class: :integer
  },

  # @!attribute pending
  #   @return [Integer]
  pending: {
    class: :integer
  },

  # @!attribute completed
  #   @return [Integer]
  completed: {
    class: :integer
  },

  # @!attribute deferred
  #   @return [Integer]
  deferred: {
    class: :integer
  },

  # @!attribute failed
  #   @return [Integer]
  failed: {
    class: :integer
  }

}

Instance Attribute Summary

• #completed ⇒ Integer
• #deferred ⇒ Integer
• #failed ⇒ Integer
• #isPolicyEnabled ⇒ Boolean
• #pending ⇒ Integer
• #policyDeploymentMethod ⇒ String
• #policyId ⇒ Integer
• #policyName ⇒ String
• #policyTargetVersion ⇒ String
• #softwareTitle ⇒ String
• #softwareTitleConfigurationId ⇒ Integer

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#completed ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/patch_policy_summary.rb', line 123

#deferred ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/patch_policy_summary.rb', line 129

#failed ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/patch_policy_summary.rb', line 135

#isPolicyEnabled ⇒ Boolean

Returns:

• (Boolean)

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

#pending ⇒ Integer

Returns:

• (Integer)

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

#policyDeploymentMethod ⇒ String

Returns:

• (String)

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

#policyId ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/patch_policy_summary.rb', line 75

#policyName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/patch_policy_summary.rb', line 81

#policyTargetVersion ⇒ String

Returns:

• (String)

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

#softwareTitle ⇒ String

Returns:

• (String)

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

#softwareTitleConfigurationId ⇒ Integer

Returns:

• (Integer)

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