Class: Jamf::OAPISchemas::ExportField

Inherits:

Jamf::OAPIObject

Object
Jamf::OAPIObject
Jamf::OAPISchemas::ExportField

show all

Defined in:: lib/jamf/api/jamf_pro/oapi_schemas/export_field.rb

Overview

OAPI Object Model and Enums for: ExportField

Description of this class from the OAPI Schema:

Field to be included in the export operation.

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

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

OAPI_PROPERTIES =

{

  # English name of the field to be exported.
  # @!attribute fieldName
  #   @return [String]
  fieldName: {
    class: :string
  },

  # Name which should be used for the label in the response - can be in any language. When null the fieldName itself will be used as the label.
  # @!attribute fieldLabelOverride
  #   @return [String]
  fieldLabelOverride: {
    class: :string,
    nil_ok: true
  }

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#fieldLabelOverride ⇒ `String`

Returns:

(String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/export_field.rb', line 77

#fieldName ⇒ `String`