Class: Jamf::OAPISchemas::CacheSettings

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

Overview

OAPI Object Model and Enums for: CacheSettings

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

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.

- Jamf::OAPISchemas::MemcachedEndpoints

Endpoints and Privileges: API endpoints and HTTP operations that use this object model, and the Jamf Pro privileges needed to access them.

- '/v1/cache-settings:GET' needs permissions:
  - Read Cache
- '/v1/cache-settings:PUT' needs permissions:
  - Update Cache

Constant Summary collapse

OAPI_PROPERTIES = 
{

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

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

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

  # @!attribute timeToLiveSeconds
  #   @return [Integer]
  timeToLiveSeconds: {
    class: :integer,
    required: true,
    format: 'int32'
  },

  # @!attribute timeToIdleSeconds
  #   @return [Integer]
  timeToIdleSeconds: {
    class: :integer,
    format: 'int32'
  },

  # @!attribute directoryTimeToLiveSeconds
  #   @return [Integer]
  directoryTimeToLiveSeconds: {
    class: :integer,
    format: 'int32'
  },

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

  # The default is for Jamf Pro to generate a UUID, so we can only give an example instead.
  # @!attribute cacheUniqueId
  #   @return [String]
  cacheUniqueId: {
    class: :string,
    required: true
  },

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

  # @!attribute memcachedEndpoints
  #   @return [Array<Jamf::OAPISchemas::MemcachedEndpoints>]
  memcachedEndpoints: {
    class: Jamf::OAPISchemas::MemcachedEndpoints,
    required: true,
    multi: true
  }

}

Instance Attribute Summary collapse

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#cacheType ⇒ String

Returns:




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

#cacheUniqueId ⇒ String

Returns:




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

#directoryTimeToLiveSeconds ⇒ Integer

Returns:

  • (Integer) 



# File 'lib/jamf/api/jamf_pro/oapi_schemas/cache_settings.rb', line 109

#ehcacheMaxBytesLocalHeap ⇒ String

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/cache_settings.rb', line 116

#elasticache ⇒ Boolean

Returns:

  • (Boolean) 



# File 'lib/jamf/api/jamf_pro/oapi_schemas/cache_settings.rb', line 130

#id ⇒ String (readonly)

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/cache_settings.rb', line 72

#memcachedEndpoints ⇒ Array<Jamf::OAPISchemas::MemcachedEndpoints>

Returns:




# File 'lib/jamf/api/jamf_pro/oapi_schemas/cache_settings.rb', line 136

#name ⇒ String

Returns:




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

#timeToIdleSeconds ⇒ Integer

Returns:

  • (Integer) 



# File 'lib/jamf/api/jamf_pro/oapi_schemas/cache_settings.rb', line 102

#timeToLiveSeconds ⇒ Integer

Returns:

  • (Integer) 



# File 'lib/jamf/api/jamf_pro/oapi_schemas/cache_settings.rb', line 94