Class: OCI::MarketplacePublisher::Models::ListingRevisionPackage

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/marketplace_publisher/models/listing_revision_package.rb

Overview

A base object for all types of listing revision packages. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

ContainerPackage, HelmChartPackage

Constant Summary collapse

PACKAGE_TYPE_ENUM = 
[
  PACKAGE_TYPE_CONTAINER_IMAGE = 'CONTAINER_IMAGE'.freeze,
  PACKAGE_TYPE_HELM_CHART = 'HELM_CHART'.freeze,
  PACKAGE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_NEW = 'NEW'.freeze,
  STATUS_PUBLISH_IN_PROGRESS = 'PUBLISH_IN_PROGRESS'.freeze,
  STATUS_UNPUBLISH_IN_PROGRESS = 'UNPUBLISH_IN_PROGRESS'.freeze,
  STATUS_PUBLISH_FAILED = 'PUBLISH_FAILED'.freeze,
  STATUS_PUBLISHED = 'PUBLISHED'.freeze,
  STATUS_PUBLISHED_AS_PRIVATE = 'PUBLISHED_AS_PRIVATE'.freeze,
  STATUS_UNPUBLISHED = 'UNPUBLISHED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ListingRevisionPackage

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :listing_revision_id (String) —

    The value to assign to the #listing_revision_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :artifact_id (String) —

    The value to assign to the #artifact_id property

  • :term_id (String) —

    The value to assign to the #term_id property

  • :package_version (String) —

    The value to assign to the #package_version property

  • :package_type (String) —

    The value to assign to the #package_type property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :status (String) —

    The value to assign to the #status property

  • :are_security_upgrades_provided (BOOLEAN) —

    The value to assign to the #are_security_upgrades_provided property

  • :is_default (BOOLEAN) —

    The value to assign to the #is_default property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :extended_metadata (Hash<String, String>) —

    The value to assign to the #extended_metadata property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 231

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.description = attributes[:'description'] if attributes[:'description']

  self.listing_revision_id = attributes[:'listingRevisionId'] if attributes[:'listingRevisionId']

  raise 'You cannot provide both :listingRevisionId and :listing_revision_id' if attributes.key?(:'listingRevisionId') && attributes.key?(:'listing_revision_id')

  self.listing_revision_id = attributes[:'listing_revision_id'] if attributes[:'listing_revision_id']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.artifact_id = attributes[:'artifactId'] if attributes[:'artifactId']

  raise 'You cannot provide both :artifactId and :artifact_id' if attributes.key?(:'artifactId') && attributes.key?(:'artifact_id')

  self.artifact_id = attributes[:'artifact_id'] if attributes[:'artifact_id']

  self.term_id = attributes[:'termId'] if attributes[:'termId']

  raise 'You cannot provide both :termId and :term_id' if attributes.key?(:'termId') && attributes.key?(:'term_id')

  self.term_id = attributes[:'term_id'] if attributes[:'term_id']

  self.package_version = attributes[:'packageVersion'] if attributes[:'packageVersion']

  raise 'You cannot provide both :packageVersion and :package_version' if attributes.key?(:'packageVersion') && attributes.key?(:'package_version')

  self.package_version = attributes[:'package_version'] if attributes[:'package_version']

  self.package_type = attributes[:'packageType'] if attributes[:'packageType']

  raise 'You cannot provide both :packageType and :package_type' if attributes.key?(:'packageType') && attributes.key?(:'package_type')

  self.package_type = attributes[:'package_type'] if attributes[:'package_type']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.status = attributes[:'status'] if attributes[:'status']

  self.are_security_upgrades_provided = attributes[:'areSecurityUpgradesProvided'] unless attributes[:'areSecurityUpgradesProvided'].nil?

  raise 'You cannot provide both :areSecurityUpgradesProvided and :are_security_upgrades_provided' if attributes.key?(:'areSecurityUpgradesProvided') && attributes.key?(:'are_security_upgrades_provided')

  self.are_security_upgrades_provided = attributes[:'are_security_upgrades_provided'] unless attributes[:'are_security_upgrades_provided'].nil?

  self.is_default = attributes[:'isDefault'] unless attributes[:'isDefault'].nil?

  raise 'You cannot provide both :isDefault and :is_default' if attributes.key?(:'isDefault') && attributes.key?(:'is_default')

  self.is_default = attributes[:'is_default'] unless attributes[:'is_default'].nil?

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

  raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated')

  self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated']

  self.extended_metadata = attributes[:'extendedMetadata'] if attributes[:'extendedMetadata']

  raise 'You cannot provide both :extendedMetadata and :extended_metadata' if attributes.key?(:'extendedMetadata') && attributes.key?(:'extended_metadata')

  self.extended_metadata = attributes[:'extended_metadata'] if attributes[:'extended_metadata']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

  raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags')

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags']
end

Instance Attribute Details

#are_security_upgrades_provided ⇒ BOOLEAN

[Required] Identifies whether security upgrades will be provided for this package.

Returns:

  • (BOOLEAN) 


87
88
89
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 87

def are_security_upgrades_provided
  @are_security_upgrades_provided
end

#artifact_id ⇒ String

[Required] The unique identifier for the artifact.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 63

def artifact_id
  @artifact_id
end

#compartment_id ⇒ String

[Required] The unique identifier for the compartment.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 59

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


128
129
130
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 128

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of this package.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 51

def description
  @description
end

#display_name ⇒ String

[Required] The name of the listing revision package.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 47

def display_name
  @display_name
end

#extended_metadata ⇒ Hash<String, String>

Additional metadata key/value pairs for the listing revision package summary.

For example:

{\"partnerListingRevisionPackageStatus\": \"Published\",\"parentListingRevisionPackageId\": \"1\" }

Returns:

  • (Hash<String, String>) 


116
117
118
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 116

def extended_metadata
  @extended_metadata
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


122
123
124
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 122

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The OCID for the listing revision package in Marketplace Publisher.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 43

def id
  @id
end

#is_default ⇒ BOOLEAN

[Required] Identifies that this will be default package for the listing revision.

Returns:

  • (BOOLEAN) 


91
92
93
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 91

def is_default
  @is_default
end

#lifecycle_state ⇒ String

[Required] The current state for the listing revision package.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 79

def lifecycle_state
  @lifecycle_state
end

#listing_revision_id ⇒ String

[Required] The unique identifier for the listing revision.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 55

def listing_revision_id
  @listing_revision_id
end

#package_type ⇒ String

[Required] The package type for the listing.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 75

def package_type
  @package_type
end

#package_version ⇒ String

[Required] The version for the package.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 71

def package_version
  @package_version
end

#status ⇒ String

[Required] The current status for the listing revision package.

Returns:

  • (String) 


83
84
85
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 83

def status
  @status
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


134
135
136
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 134

def system_tags
  @system_tags
end

#term_id ⇒ String

[Required] The unique identifier for the term.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 67

def term_id
  @term_id
end

#time_created ⇒ DateTime

[Required] The date and time this listing revision package was created, expressed in RFC 3339 timestamp format.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


99
100
101
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 99

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time this listing revision package was updated, expressed in RFC 3339 timestamp format.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


107
108
109
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 107

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 137

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'listing_revision_id': :'listingRevisionId',
    'compartment_id': :'compartmentId',
    'artifact_id': :'artifactId',
    'term_id': :'termId',
    'package_version': :'packageVersion',
    'package_type': :'packageType',
    'lifecycle_state': :'lifecycleState',
    'status': :'status',
    'are_security_upgrades_provided': :'areSecurityUpgradesProvided',
    'is_default': :'isDefault',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'extended_metadata': :'extendedMetadata',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



195
196
197
198
199
200
201
202
203
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 195

def self.get_subtype(object_hash)
  type = object_hash[:'packageType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::MarketplacePublisher::Models::HelmChartPackage' if type == 'HELM_CHART'
  return 'OCI::MarketplacePublisher::Models::ContainerPackage' if type == 'CONTAINER_IMAGE'

  # TODO: Log a warning when the subtype is not found.
  'OCI::MarketplacePublisher::Models::ListingRevisionPackage'
end

.swagger_types ⇒ Object

Attribute type mapping.



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 164

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'listing_revision_id': :'String',
    'compartment_id': :'String',
    'artifact_id': :'String',
    'term_id': :'String',
    'package_version': :'String',
    'package_type': :'String',
    'lifecycle_state': :'String',
    'status': :'String',
    'are_security_upgrades_provided': :'BOOLEAN',
    'is_default': :'BOOLEAN',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'extended_metadata': :'Hash<String, String>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 386

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    listing_revision_id == other.listing_revision_id &&
    compartment_id == other.compartment_id &&
    artifact_id == other.artifact_id &&
    term_id == other.term_id &&
    package_version == other.package_version &&
    package_type == other.package_type &&
    lifecycle_state == other.lifecycle_state &&
    status == other.status &&
    are_security_upgrades_provided == other.are_security_upgrades_provided &&
    is_default == other.is_default &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    extended_metadata == other.extended_metadata &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 434

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


414
415
416
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 414

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



423
424
425
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 423

def hash
  [id, display_name, description, listing_revision_id, compartment_id, artifact_id, term_id, package_version, package_type, lifecycle_state, status, are_security_upgrades_provided, is_default, time_created, time_updated, extended_metadata, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



467
468
469
470
471
472
473
474
475
476
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 467

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



461
462
463
 
# File 'lib/oci/marketplace_publisher/models/listing_revision_package.rb', line 461

def to_s
  to_hash.to_s
end