Class: Jamf::OAPISchemas::JamfProtectPlan

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::JamfProtectPlan

Defined in:

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

Overview

OAPI Object Model and Enums for: JamfProtectPlan

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

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

OAPI_PROPERTIES =

{

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

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

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

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

  # @!attribute [r] profileId
  #   @return [Integer]
  profileId: {
    class: :integer,
    readonly: true
  },

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

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

}

Instance Attribute Summary

• #description ⇒ String readonly
• #id ⇒ String readonly
• #name ⇒ String readonly
• #profileId ⇒ Integer readonly
• #profileName ⇒ String readonly
• #scopeDescription ⇒ String readonly
• #uuid ⇒ String readonly

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#description ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/jamf_protect_plan.rb', line 91

#id ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/jamf_protect_plan.rb', line 76

#name ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/jamf_protect_plan.rb', line 84

#profileId ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/jamf_protect_plan.rb', line 98

#profileName ⇒ String (readonly)

Returns:

• (String)

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

#scopeDescription ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/jamf_protect_plan.rb', line 112

#uuid ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/jamf_protect_plan.rb', line 69