Class: OCI::MarketplacePublisher::Models::Artifact

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

Overview

Base model object for the artifacts. 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

Constant Summary collapse

ARTIFACT_TYPE_ENUM = 
[
  ARTIFACT_TYPE_CONTAINER_IMAGE = 'CONTAINER_IMAGE'.freeze,
  ARTIFACT_TYPE_HELM_CHART = 'HELM_CHART'.freeze,
  ARTIFACT_TYPE_MACHINE_IMAGE = 'MACHINE_IMAGE'.freeze,
  ARTIFACT_TYPE_STACK = 'STACK'.freeze,
  ARTIFACT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATUS_ENUM = 
[
  STATUS_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  STATUS_AVAILABLE = 'AVAILABLE'.freeze,
  STATUS_UNAVAILABLE = 'UNAVAILABLE'.freeze,
  STATUS_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_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 = {}) ⇒ Artifact

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

  • :artifact_type (String) —

    The value to assign to the #artifact_type property

  • :status (String) —

    The value to assign to the #status property

  • :status_notes (String) —

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

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :publisher_id (String) —

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



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
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/oci/marketplace_publisher/models/artifact.rb', line 181

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

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

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

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

  self.status_notes = attributes[:'statusNotes'] if attributes[:'statusNotes']

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

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

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

#artifact_type ⇒ String

[Required] Artifact type for the artifact.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/marketplace_publisher/models/artifact.rb', line 48

def artifact_type
  @artifact_type
end

#compartment_id ⇒ String

[Required] The unique identifier for the compartment.

Returns:

  • (String) 


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

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


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A display name for the artifact.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/marketplace_publisher/models/artifact.rb', line 44

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique OCID identifier for the artifact.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/marketplace_publisher/models/artifact.rb', line 40

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state for the Artifact.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/marketplace_publisher/models/artifact.rb', line 60

def lifecycle_state
  @lifecycle_state
end

#publisher_id ⇒ String

[Required] The unique identifier for the publisher.

Returns:

  • (String) 


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

def publisher_id
  @publisher_id
end

#status ⇒ String

[Required] The current status for the Artifact.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/marketplace_publisher/models/artifact.rb', line 52

def status
  @status
end

#status_notes ⇒ String

Status notes for the Artifact.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/marketplace_publisher/models/artifact.rb', line 56

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


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

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Example: 2022-09-15T21:10:29.600Z

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Example: 2022-09-15T21:10:29.600Z

Returns:

  • (DateTime) 


82
83
84
 
# File 'lib/oci/marketplace_publisher/models/artifact.rb', line 82

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/marketplace_publisher/models/artifact.rb', line 103

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'artifact_type': :'artifactType',
    'status': :'status',
    'status_notes': :'statusNotes',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'compartment_id': :'compartmentId',
    'publisher_id': :'publisherId',
    'time_updated': :'timeUpdated',
    '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.



149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/marketplace_publisher/models/artifact.rb', line 149

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

  return 'OCI::MarketplacePublisher::Models::MachineImageArtifact' if type == 'MACHINE_IMAGE'
  return 'OCI::MarketplacePublisher::Models::StackArtifact' if type == 'STACK'
  return 'OCI::MarketplacePublisher::Models::ContainerImageArtifact' if type == 'CONTAINER_IMAGE'
  return 'OCI::MarketplacePublisher::Models::KubernetesImageArtifact' if type == 'HELM_CHART'

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

.swagger_types ⇒ Object

Attribute type mapping.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/oci/marketplace_publisher/models/artifact.rb', line 124

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'artifact_type': :'String',
    'status': :'String',
    'status_notes': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'compartment_id': :'String',
    'publisher_id': :'String',
    '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



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/oci/marketplace_publisher/models/artifact.rb', line 304

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    artifact_type == other.artifact_type &&
    status == other.status &&
    status_notes == other.status_notes &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    compartment_id == other.compartment_id &&
    publisher_id == other.publisher_id &&
    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



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/oci/marketplace_publisher/models/artifact.rb', line 346

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


326
327
328
 
# File 'lib/oci/marketplace_publisher/models/artifact.rb', line 326

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



335
336
337
 
# File 'lib/oci/marketplace_publisher/models/artifact.rb', line 335

def hash
  [id, display_name, artifact_type, status, status_notes, lifecycle_state, time_created, compartment_id, publisher_id, 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



379
380
381
382
383
384
385
386
387
388
 
# File 'lib/oci/marketplace_publisher/models/artifact.rb', line 379

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



373
374
375
 
# File 'lib/oci/marketplace_publisher/models/artifact.rb', line 373

def to_s
  to_hash.to_s
end