Class: Jamf::OAPISchemas::StartupStatus

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::StartupStatus

Defined in:

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

Overview

OAPI Object Model and Enums for: StartupStatus

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.

- '/startup-status:GET' needs permissions:
  - Unknown

Constant Summary

STEP_CODE_OPTIONS =

Enums used by this class or others

[
  'SERVER_INIT_START',
  'SERVER_INIT_ANALYZING_WEBAPP',
  'SERVER_INIT_POPULATING_NAVIGATION',
  'SERVER_INIT_POPULATING_OBJECTS',
  'SERVER_INIT_INITIALIZING_OBJ',
  'SERVER_INIT_VERIFYING_CACHE',
  'SERVER_INIT_INITIALIZING_CHANGE_MANAGEMENT',
  'SERVER_INIT_INITIALIZING_COMMUNICATION_SYSTEM',
  'SERVER_INIT_INITIALIZING_MDM_QUEUE_MONITOR',
  'SERVER_INIT_CALCULATING_SMART_GROUPS',
  'SERVER_INIT_DB_SCHEMA_COMPARE',
  'SERVER_INIT_DB_TABLE_CHECK_FOR_RENAME',
  'SERVER_INIT_DB_TABLE_ALTER',
  'SERVER_INIT_DB_TABLE_ANALYZING',
  'SERVER_INIT_DB_TABLE_CREATE',
  'SERVER_INIT_DB_TABLE_DROP',
  'SERVER_INIT_DB_TABLE_RENAME',
  'SERVER_INIT_DB_COLUMN_RENAME',
  'SERVER_INIT_DB_COLUMN_ENCODING_CHANGE_STEP_1',
  'SERVER_INIT_DB_COLUMN_ENCODING_CHANGE_STEP_2',
  'SERVER_INIT_DB_COLUMN_ENCODING_CHANGE_STEP_3',
  'SERVER_INIT_DB_UPGRADE_CHECK',
  'SERVER_INIT_DB_UPGRADE_COMPLETE',
  'SERVER_INIT_SS_GENERATE_NOTIFICATIONS',
  'SERVER_INIT_SS_GENERATE_NOTIFICATIONS_STATUS',
  'SERVER_INIT_SS_GENERATE_NOTIFICATIONS_FINALIZE',
  'SERVER_INIT_PKI_MIGRATION_DONE',
  'SERVER_INIT_PKI_MIGRATION_STATUS',
  'SERVER_INIT_MEMCACHED_ENDPOINTS_CHECK',
  'SERVER_INIT_CACHE_FLUSHING',
  'SERVER_INIT_COMPLETE'
]

WARNING_CODE_OPTIONS =

[
  'SERVER_INIT_WARNING_DB_TABLE_ENCODING'
]

ERROR_CODE_OPTIONS =

[
  'CACHE_CONFIGURATION_ERROR',
  'SECONDARY_NODE_STARTUP_ERROR',
  'MORE_THAN_ONE_CLUSTER_SETTINGS_ERROR',
  'PRIMARY_NODE_NOT_SET_ERROR',
  'DATABASE_ERROR',
  'DATABASE_PASSWORD_MISSING',
  'EHCACHE_ERROR',
  'FLAG_INITIALIZATION_FAILED',
  'MEMCACHED_ERROR',
  'DATABASE_MYISAM_ERROR',
  'OLD_VERSION_ERROR'
]

OAPI_PROPERTIES =

{

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

  # @!attribute stepCode
  #   @return [String]
  stepCode: {
    class: :string,
    enum: STEP_CODE_OPTIONS
  },

  # @!attribute stepParam
  #   @return [String]
  stepParam: {
    class: :string,
    nil_ok: true
  },

  # @!attribute percentage
  #   @return [Integer]
  percentage: {
    class: :integer
  },

  # @!attribute warning
  #   @return [String]
  warning: {
    class: :string,
    nil_ok: true
  },

  # @!attribute warningCode
  #   @return [String]
  warningCode: {
    class: :string,
    nil_ok: true,
    enum: WARNING_CODE_OPTIONS
  },

  # @!attribute warningParam
  #   @return [String]
  warningParam: {
    class: :string,
    nil_ok: true
  },

  # @!attribute error
  #   @return [String]
  error: {
    class: :string,
    nil_ok: true
  },

  # @!attribute errorCode
  #   @return [String]
  errorCode: {
    class: :string,
    nil_ok: true,
    enum: ERROR_CODE_OPTIONS
  },

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

}

Instance Attribute Summary

• #error ⇒ String
• #errorCode ⇒ String
• #percentage ⇒ Integer
• #setupAssistantNecessary ⇒ Boolean
• #step ⇒ String
• #stepCode ⇒ String
• #stepParam ⇒ String
• #warning ⇒ String
• #warningCode ⇒ String
• #warningParam ⇒ String

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#error ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/startup_status.rb', line 170

#errorCode ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/startup_status.rb', line 177

#percentage ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/startup_status.rb', line 142

#setupAssistantNecessary ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/startup_status.rb', line 185

#step ⇒ String

Returns:

• (String)

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

#stepCode ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/startup_status.rb', line 128

#stepParam ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/startup_status.rb', line 135

#warning ⇒ String

Returns:

• (String)

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

#warningCode ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/startup_status.rb', line 155

#warningParam ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/startup_status.rb', line 163