Class: Jamf::OAPISchemas::Package

Inherits:

Jamf::OAPIObject

• Object
• Jamf::OAPIObject
• Jamf::OAPISchemas::Package

Defined in:

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

Overview

OAPI Object Model and Enums for: Package

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

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/packages:POST' needs permissions:
  • Create Packages
• '/v1/packages/#id:GET' needs permissions:
  • Read Packages
• '/v1/packages/#id:PUT' needs permissions:
  • Update Packages
• '/v1/packages/#id/manifest:POST' needs permissions:
  • Update Packages
  • Read Packages

Direct Known Subclasses

JPackage

Constant Summary

OAPI_PROPERTIES =

{

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

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

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

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

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

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

  # @!attribute priority
  #   @return [Integer]
  priority: {
    class: :integer,
    required: true
  },

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

  # @!attribute fillUserTemplate
  #   @return [Boolean]
  fillUserTemplate: {
    class: :boolean,
    required: true
  },

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

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

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

  # @!attribute rebootRequired
  #   @return [Boolean]
  rebootRequired: {
    class: :boolean,
    required: true
  },

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

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

  # @!attribute osInstall
  #   @return [Boolean]
  osInstall: {
    class: :boolean,
    required: true
  },

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

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

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

  # @!attribute suppressUpdates
  #   @return [Boolean]
  suppressUpdates: {
    class: :boolean,
    required: true
  },

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

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

  # @!attribute suppressFromDock
  #   @return [Boolean]
  suppressFromDock: {
    class: :boolean,
    required: true
  },

  # @!attribute suppressEula
  #   @return [Boolean]
  suppressEula: {
    class: :boolean,
    required: true
  },

  # @!attribute suppressRegistration
  #   @return [Boolean]
  suppressRegistration: {
    class: :boolean,
    required: true
  },

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

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

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

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

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

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

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

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

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

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

}

Instance Attribute Summary

• #basePath ⇒ String
• #categoryId ⇒ String
• #cloudTransferStatus ⇒ String readonly
• #fileName ⇒ String
• #fillExistingUsers ⇒ Boolean
• #fillUserTemplate ⇒ Boolean
• #format ⇒ String
• #hashType ⇒ String
• #hashValue ⇒ String
• #id ⇒ String readonly
• #ignoreConflicts ⇒ Boolean
• #indexed ⇒ Boolean readonly
• #info ⇒ String
• #installLanguage ⇒ String
• #manifest ⇒ String
• #manifestFileName ⇒ String
• #md5 ⇒ String
• #notes ⇒ String
• #osInstall ⇒ Boolean
• #osInstallerVersion ⇒ String
• #osRequirements ⇒ String
• #packageName ⇒ String
• #parentPackageId ⇒ String
• #priority ⇒ Integer
• #rebootRequired ⇒ Boolean
• #selfHealingAction ⇒ String
• #selfHealNotify ⇒ Boolean
• #serialNumber ⇒ String
• #sha256 ⇒ String
• #size ⇒ String readonly
• #suppressEula ⇒ Boolean
• #suppressFromDock ⇒ Boolean
• #suppressRegistration ⇒ Boolean
• #suppressUpdates ⇒ Boolean
• #swu ⇒ Boolean

Constructor Details

This class inherits a constructor from Jamf::OAPIObject

Instance Attribute Details

#basePath ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 180

#categoryId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 78

#cloudTransferStatus ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 194

#fileName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 71

#fillExistingUsers ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 127

#fillUserTemplate ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 113

#format ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 292

#hashType ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 249

#hashValue ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 256

#id ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 56

#ignoreConflicts ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 201

#indexed ⇒ Boolean (readonly)

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 120

#info ⇒ String

Returns:

• (String)

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

#installLanguage ⇒ String

Returns:

• (String)

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

#manifest ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 278

#manifestFileName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 285

#md5 ⇒ String

Returns:

• (String)

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

#notes ⇒ String

Returns:

• (String)

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

#osInstall ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 159

#osInstallerVersion ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 271

#osRequirements ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 106

#packageName ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 64

#parentPackageId ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 173

#priority ⇒ Integer

Returns:

• (Integer)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 99

#rebootRequired ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 139

#selfHealingAction ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 152

#selfHealNotify ⇒ Boolean

Returns:

• (Boolean)

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

#serialNumber ⇒ String

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 166

#sha256 ⇒ String

Returns:

• (String)

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

#size ⇒ String (readonly)

Returns:

• (String)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 263

#suppressEula ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 214

#suppressFromDock ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 207

#suppressRegistration ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 221

#suppressUpdates ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 187

#swu ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/jamf/api/jamf_pro/oapi_schemas/package.rb', line 133