Class: Jamf::OAPISchemas::ComputerContentCaching

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::ComputerContentCaching

Defined in:

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

Overview

OAPI Object Model and Enums for: ComputerContentCaching

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

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

Sub Objects: Other object models used by this model's attributes.

- Jamf::OAPISchemas::ComputerContentCachingParent
- Jamf::OAPISchemas::ComputerContentCachingAlert
- Jamf::OAPISchemas::ComputerContentCachingCacheDetail
- Jamf::OAPISchemas::ComputerContentCachingDataMigrationError

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

Constant Summary

REGISTRATION_STATUS_OPTIONS =

Enums used by this class or others

[
  'CONTENT_CACHING_FAILED',
  'CONTENT_CACHING_PENDING',
  'CONTENT_CACHING_SUCCEEDED'
]

TETHERATOR_STATUS_OPTIONS =

[
  'CONTENT_CACHING_UNKNOWN',
  'CONTENT_CACHING_DISABLED',
  'CONTENT_CACHING_ENABLED'
]

OAPI_PROPERTIES =

{

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

  # @!attribute [r] parents
  #   @return [Array<Jamf::OAPISchemas::ComputerContentCachingParent>]
  parents: {
    class: Jamf::OAPISchemas::ComputerContentCachingParent,
    readonly: true,
    multi: true
  },

  # @!attribute [r] alerts
  #   @return [Array<Jamf::OAPISchemas::ComputerContentCachingAlert>]
  alerts: {
    class: Jamf::OAPISchemas::ComputerContentCachingAlert,
    readonly: true,
    multi: true
  },

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

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

  # @!attribute [r] actualCacheBytesUsed
  #   @return [Integer]
  actualCacheBytesUsed: {
    class: :integer,
    format: 'int64',
    readonly: true
  },

  # @!attribute [r] cacheDetails
  #   @return [Array<Jamf::OAPISchemas::ComputerContentCachingCacheDetail>]
  cacheDetails: {
    class: Jamf::OAPISchemas::ComputerContentCachingCacheDetail,
    readonly: true,
    multi: true
  },

  # @!attribute [r] cacheBytesFree
  #   @return [Integer]
  cacheBytesFree: {
    class: :integer,
    format: 'int64',
    readonly: true
  },

  # @!attribute [r] cacheBytesLimit
  #   @return [Integer]
  cacheBytesLimit: {
    class: :integer,
    format: 'int64',
    readonly: true
  },

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

  # @!attribute [r] cacheBytesUsed
  #   @return [Integer]
  cacheBytesUsed: {
    class: :integer,
    format: 'int64',
    readonly: true
  },

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

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

  # @!attribute dataMigrationError
  #   @return [Jamf::OAPISchemas::ComputerContentCachingDataMigrationError]
  dataMigrationError: {
    class: Jamf::OAPISchemas::ComputerContentCachingDataMigrationError
  },

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

  # @!attribute [r] personalCacheBytesFree
  #   @return [Integer]
  personalCacheBytesFree: {
    class: :integer,
    format: 'int64',
    readonly: true
  },

  # @!attribute [r] personalCacheBytesLimit
  #   @return [Integer]
  personalCacheBytesLimit: {
    class: :integer,
    format: 'int64',
    readonly: true
  },

  # @!attribute [r] personalCacheBytesUsed
  #   @return [Integer]
  personalCacheBytesUsed: {
    class: :integer,
    format: 'int64',
    readonly: true
  },

  # @!attribute [r] port
  #   @return [Integer]
  port: {
    class: :integer,
    format: 'int64',
    readonly: true
  },

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

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

  # @!attribute [r] registrationResponseCode
  #   @return [Integer]
  registrationResponseCode: {
    class: :integer,
    format: 'int64',
    readonly: true
  },

  # @!attribute [r] registrationStarted
  #   @return [Jamf::Timestamp]
  registrationStarted: {
    class: Jamf::Timestamp,
    format: 'date-time',
    readonly: true
  },

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

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

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

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

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

  # @!attribute [r] totalBytesAreSince
  #   @return [Jamf::Timestamp]
  totalBytesAreSince: {
    class: Jamf::Timestamp,
    format: 'date-time',
    readonly: true
  },

  # @!attribute [r] totalBytesDropped
  #   @return [Integer]
  totalBytesDropped: {
    class: :integer,
    format: 'int64',
    readonly: true
  },

  # @!attribute [r] totalBytesImported
  #   @return [Integer]
  totalBytesImported: {
    class: :integer,
    format: 'int64',
    readonly: true
  },

  # @!attribute [r] totalBytesReturnedToChildren
  #   @return [Integer]
  totalBytesReturnedToChildren: {
    class: :integer,
    format: 'int64',
    readonly: true
  },

  # @!attribute [r] totalBytesReturnedToClients
  #   @return [Integer]
  totalBytesReturnedToClients: {
    class: :integer,
    format: 'int64',
    readonly: true
  },

  # @!attribute [r] totalBytesReturnedToPeers
  #   @return [Integer]
  totalBytesReturnedToPeers: {
    class: :integer,
    format: 'int64',
    readonly: true
  },

  # @!attribute [r] totalBytesStoredFromOrigin
  #   @return [Integer]
  totalBytesStoredFromOrigin: {
    class: :integer,
    format: 'int64',
    readonly: true
  },

  # @!attribute [r] totalBytesStoredFromParents
  #   @return [Integer]
  totalBytesStoredFromParents: {
    class: :integer,
    format: 'int64',
    readonly: true
  },

  # @!attribute [r] totalBytesStoredFromPeers
  #   @return [Integer]
  totalBytesStoredFromPeers: {
    class: :integer,
    format: 'int64',
    readonly: true
  }

}

Instance Attribute Summary

• #activated ⇒ Boolean readonly
• #active ⇒ Boolean readonly
• #actualCacheBytesUsed ⇒ Integer readonly
• #alerts ⇒ Array<Jamf::OAPISchemas::ComputerContentCachingAlert> readonly
• #cacheBytesFree ⇒ Integer readonly
• #cacheBytesLimit ⇒ Integer readonly
• #cacheBytesUsed ⇒ Integer readonly
• #cacheDetails ⇒ Array<Jamf::OAPISchemas::ComputerContentCachingCacheDetail> readonly
• #cacheStatus ⇒ String readonly
• #computerContentCachingInformationId ⇒ String readonly
• #dataMigrationCompleted ⇒ Boolean readonly
• #dataMigrationError ⇒ Jamf::OAPISchemas::ComputerContentCachingDataMigrationError
• #dataMigrationProgressPercentage ⇒ Integer readonly
• #maxCachePressureLast1HourPercentage ⇒ Integer readonly
• #parents ⇒ Array<Jamf::OAPISchemas::ComputerContentCachingParent> readonly
• #personalCacheBytesFree ⇒ Integer readonly
• #personalCacheBytesLimit ⇒ Integer readonly
• #personalCacheBytesUsed ⇒ Integer readonly
• #port ⇒ Integer readonly
• #publicAddress ⇒ String readonly
• #registrationError ⇒ String readonly
• #registrationResponseCode ⇒ Integer readonly
• #registrationStarted ⇒ Jamf::Timestamp readonly
• #registrationStatus ⇒ String readonly
• #restrictedMedia ⇒ Boolean readonly
• #serverGuid ⇒ String readonly
• #startupStatus ⇒ String readonly
• #tetheratorStatus ⇒ String readonly
• #totalBytesAreSince ⇒ Jamf::Timestamp readonly
• #totalBytesDropped ⇒ Integer readonly
• #totalBytesImported ⇒ Integer readonly
• #totalBytesReturnedToChildren ⇒ Integer readonly
• #totalBytesReturnedToClients ⇒ Integer readonly
• #totalBytesReturnedToPeers ⇒ Integer readonly
• #totalBytesStoredFromOrigin ⇒ Integer readonly
• #totalBytesStoredFromParents ⇒ Integer readonly
• #totalBytesStoredFromPeers ⇒ Integer readonly

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#activated ⇒ Boolean (readonly)

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 108

#active ⇒ Boolean (readonly)

Returns:

• (Boolean)

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

#actualCacheBytesUsed ⇒ Integer (readonly)

Returns:

• (Integer)

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

#alerts ⇒ Array<Jamf::OAPISchemas::ComputerContentCachingAlert> (readonly)

Returns:

• (Array<Jamf::OAPISchemas::ComputerContentCachingAlert>)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 100

#cacheBytesFree ⇒ Integer (readonly)

Returns:

• (Integer)

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

#cacheBytesLimit ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 146

#cacheBytesUsed ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 161

#cacheDetails ⇒ Array<Jamf::OAPISchemas::ComputerContentCachingCacheDetail> (readonly)

Returns:

• (Array<Jamf::OAPISchemas::ComputerContentCachingCacheDetail>)

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

#cacheStatus ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 154

#computerContentCachingInformationId ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 85

#dataMigrationCompleted ⇒ Boolean (readonly)

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 169

#dataMigrationError ⇒ Jamf::OAPISchemas::ComputerContentCachingDataMigrationError

Returns:

• (Jamf::OAPISchemas::ComputerContentCachingDataMigrationError)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 183

#dataMigrationProgressPercentage ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 176

#maxCachePressureLast1HourPercentage ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 189

#parents ⇒ Array<Jamf::OAPISchemas::ComputerContentCachingParent> (readonly)

Returns:

• (Array<Jamf::OAPISchemas::ComputerContentCachingParent>)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 92

#personalCacheBytesFree ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 196

#personalCacheBytesLimit ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 204

#personalCacheBytesUsed ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 212

#port ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 220

#publicAddress ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 228

#registrationError ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 235

#registrationResponseCode ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 242

#registrationStarted ⇒ Jamf::Timestamp (readonly)

Returns:

• (Jamf::Timestamp)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 250

#registrationStatus ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 258

#restrictedMedia ⇒ Boolean (readonly)

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 266

#serverGuid ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 273

#startupStatus ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 280

#tetheratorStatus ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 287

#totalBytesAreSince ⇒ Jamf::Timestamp (readonly)

Returns:

• (Jamf::Timestamp)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 295

#totalBytesDropped ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 303

#totalBytesImported ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 311

#totalBytesReturnedToChildren ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 319

#totalBytesReturnedToClients ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 327

#totalBytesReturnedToPeers ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 335

#totalBytesStoredFromOrigin ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 343

#totalBytesStoredFromParents ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 351

#totalBytesStoredFromPeers ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/computer_content_caching.rb', line 359