Class: Jamf::OAPISchemas::DockItem

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::DockItem

Defined in:

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

Overview

OAPI Object Model and Enums for: DockItem

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.

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.

- '/v1/dock-items:POST' needs permissions:
  - Create Dock Items
- '/v1/dock-items/{id}:GET' needs permissions:
  - Read Dock Items
- '/v1/dock-items/{id}:PUT' needs permissions:
  - Update Dock Items

Constant Summary

TYPE_OPTIONS =

Enums used by this class or others

[
  'APP',
  'FILE',
  'FOLDER'
]

OAPI_PROPERTIES =

{

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

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

  # @!attribute type
  #   @return [String]
  type: {
    class: :string,
    required: true,
    enum: TYPE_OPTIONS
  },

  # @!attribute path
  #   @return [String]
  path: {
    class: :string,
    required: true
  },

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

}

Instance Attribute Summary

• #contents ⇒ String readonly
• #id ⇒ String readonly
• #name ⇒ String
• #path ⇒ String
• #type ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#contents ⇒ String (readonly)

Returns:

• (String)

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

#id ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/dock_item.rb', line 80

#name ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/dock_item.rb', line 89

#path ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/dock_item.rb', line 104

#type ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/dock_item.rb', line 96