Class: Jamf::OAPISchemas::ComputerExtensionAttribute

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

Overview

OAPI Object Model and Enums for: ComputerExtensionAttribute

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::ComputerGeneral
- Jamf::OAPISchemas::ComputerGeneralUpdate
- Jamf::OAPISchemas::ComputerHardware
- Jamf::OAPISchemas::ComputerHardwareUpdate
- Jamf::OAPISchemas::ComputerInventory
- Jamf::OAPISchemas::ComputerInventoryUpdateRequest
- Jamf::OAPISchemas::ComputerOperatingSystem
- Jamf::OAPISchemas::ComputerOperatingSystemUpdate
- Jamf::OAPISchemas::ComputerPurchase
- Jamf::OAPISchemas::ComputerUserAndLocation

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

DATA_TYPE_OPTIONS =

Enums used by this class or others

[
  'STRING',
  'INTEGER',
  'DATE_TIME'
]
INPUT_TYPE_OPTIONS = 
[
  'TEXT',
  'POPUP',
  'SCRIPT',
  'LDAP'
]
OAPI_PROPERTIES = 
{

  # An identifier of extension attribute definition.
  # @!attribute definitionId
  #   @return [String]
  definitionId: {
    class: :string
  },

  # A human-readable name by which attribute can be referred to.
  # @!attribute [r] name
  #   @return [String]
  name: {
    class: :string,
    readonly: true
  },

  # An additional explanation of exact attribute meaning, possible values, etc.
  # @!attribute [r] description
  #   @return [String]
  description: {
    class: :string,
    nil_ok: true,
    readonly: true
  },

  # @!attribute [r] enabled
  #   @return [Boolean]
  enabled: {
    class: :boolean,
    readonly: true
  },

  # @!attribute [r] multiValue
  #   @return [Boolean]
  multiValue: {
    class: :boolean,
    readonly: true
  },

  # A value of extension attribute, in some rare cases there may be multiple values present, hence the array.
  # @!attribute values
  #   @return [Array<String>]
  values: {
    class: :string,
    nil_ok: true,
    multi: true
  },

  # A data type of extension attribute.
  # @!attribute [r] dataType
  #   @return [String]
  dataType: {
    class: :string,
    nil_ok: true,
    readonly: true,
    enum: DATA_TYPE_OPTIONS
  },

  # A closed list of possible values (applies to `popup` input type).
  # @!attribute [r] options
  #   @return [Array<String>]
  options: {
    class: :string,
    nil_ok: true,
    readonly: true,
    multi: true
  },

  # The input method. `text` is most common and means simply free text, `popup` i a closed list of values from
  # which one or many can be selected and `script` value is calculated and can never be set directly.
  # @!attribute [r] inputType
  #   @return [String]
  inputType: {
    class: :string,
    nil_ok: true,
    readonly: true,
    enum: INPUT_TYPE_OPTIONS
  }

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#dataType ⇒ String (readonly)

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_extension_attribute.rb', line 138

#definitionId ⇒ String

Returns:




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

#description ⇒ String (readonly)

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_extension_attribute.rb', line 106

#enabled ⇒ Boolean (readonly)

Returns:

  • (Boolean) 



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

#inputType ⇒ String (readonly)

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_extension_attribute.rb', line 158

#multiValue ⇒ Boolean (readonly)

Returns:

  • (Boolean) 



# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_extension_attribute.rb', line 122

#name ⇒ String (readonly)

Returns:




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

#options ⇒ Array<String> (readonly)

Returns:




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

#values ⇒ Array<String>

Returns:




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