Class: OCI::MarketplacePublisher::Models::Listing

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

Overview

The model for the Marketplace Publisher listing.

Constant Summary collapse

LISTING_TYPE_ENUM = 
[
  LISTING_TYPE_OCI_APPLICATION = 'OCI_APPLICATION'.freeze,
  LISTING_TYPE_LEAD_GENERATION = 'LEAD_GENERATION'.freeze,
  LISTING_TYPE_SERVICE = 'SERVICE'.freeze,
  LISTING_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
PACKAGE_TYPE_ENUM = 
[
  PACKAGE_TYPE_CONTAINER_IMAGE = 'CONTAINER_IMAGE'.freeze,
  PACKAGE_TYPE_HELM_CHART = 'HELM_CHART'.freeze,
  PACKAGE_TYPE_MACHINE_IMAGE = 'MACHINE_IMAGE'.freeze,
  PACKAGE_TYPE_STACK = 'STACK'.freeze,
  PACKAGE_TYPE_NONE = 'NONE'.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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Listing

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

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :publisher_id (String) —

    The value to assign to the #publisher_id property

  • :listing_type (String) —

    The value to assign to the #listing_type property

  • :name (String) —

    The value to assign to the #name property

  • :package_type (String) —

    The value to assign to the #package_type property

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

    The value to assign to the #extended_metadata property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state 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

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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 169

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.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.publisher_id = attributes[:'publisherId'] if attributes[:'publisherId']

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

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

  self.listing_type = attributes[:'listingType'] if attributes[:'listingType']

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

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

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

  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.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.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.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.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

#compartment_id ⇒ String

[Required] The unique identifier for the compartment.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 45

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>>) 


100
101
102
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 100

def defined_tags
  @defined_tags
end

#extended_metadata ⇒ Hash<String, String>

Additional metadata key/value pairs for the listing summary.

For example:

{\"listingRevisionStatus\": \"Published\",\"listingRevision\": \"1\" }

Returns:

  • (Hash<String, String>) 


70
71
72
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 70

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>) 


94
95
96
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 94

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique OCID identifier for the listing.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 41

def id
  @id
end

#lifecycle_state ⇒ String

The current state of the Listing.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 74

def lifecycle_state
  @lifecycle_state
end

#listing_type ⇒ String

[Required] The listing type for the listing.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 53

def listing_type
  @listing_type
end

#name ⇒ String

[Required] Name for the listing.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 57

def name
  @name
end

#package_type ⇒ String

[Required] The package type for the listing.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 61

def package_type
  @package_type
end

#publisher_id ⇒ String

[Required] The unique identifier for the publisher.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 49

def publisher_id
  @publisher_id
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>>) 


106
107
108
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 106

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the listing was created, in the format defined by RFC3339.

Example: 2023-03-27T21:10:29.600Z

Returns:

  • (DateTime) 


81
82
83
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 81

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time the listing was updated, in the format defined by RFC3339.

Example: 2023-03-27T21:10:29.600Z

Returns:

  • (DateTime) 


88
89
90
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 88

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 109

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'publisher_id': :'publisherId',
    'listing_type': :'listingType',
    'name': :'name',
    'package_type': :'packageType',
    'extended_metadata': :'extendedMetadata',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 130

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'publisher_id': :'String',
    'listing_type': :'String',
    'name': :'String',
    'package_type': :'String',
    'extended_metadata': :'Hash<String, String>',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    '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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 292

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    publisher_id == other.publisher_id &&
    listing_type == other.listing_type &&
    name == other.name &&
    package_type == other.package_type &&
    extended_metadata == other.extended_metadata &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    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



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 334

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


314
315
316
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 314

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



323
324
325
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 323

def hash
  [id, compartment_id, publisher_id, listing_type, name, package_type, extended_metadata, lifecycle_state, time_created, time_updated, 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



367
368
369
370
371
372
373
374
375
376
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 367

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



361
362
363
 
# File 'lib/oci/marketplace_publisher/models/listing.rb', line 361

def to_s
  to_hash.to_s
end