Class: OCI::Artifacts::Models::ContainerImage

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/artifacts/models/container_image.rb

Overview

Container image metadata.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.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 = {}) ⇒ ContainerImage

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
 
# File 'lib/oci/artifacts/models/container_image.rb', line 192

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

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

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

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

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

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

  self.layers_size_in_bytes = attributes[:'layersSizeInBytes'] if attributes[:'layersSizeInBytes']

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

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

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

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

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

  self.pull_count = attributes[:'pullCount'] if attributes[:'pullCount']

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

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

  self.repository_id = attributes[:'repositoryId'] if attributes[:'repositoryId']

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

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

  self.repository_name = attributes[:'repositoryName'] if attributes[:'repositoryName']

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

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

  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_last_pulled = attributes[:'timeLastPulled'] if attributes[:'timeLastPulled']

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

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

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

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

  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 compartment OCID to which the container image belongs. Inferred from the container repository.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/artifacts/models/container_image.rb', line 21

def compartment_id
  @compartment_id
end

#created_by ⇒ String

[Required] The OCID of the user or principal that created the resource.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/artifacts/models/container_image.rb', line 25

def created_by
  @created_by
end

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

[Required] Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


105
106
107
 
# File 'lib/oci/artifacts/models/container_image.rb', line 105

def defined_tags
  @defined_tags
end

#digest ⇒ String

[Required] The container image digest.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/artifacts/models/container_image.rb', line 29

def digest
  @digest
end

#display_name ⇒ String

[Required] The repository name and the most recent version associated with the image. If there are no versions associated with the image, then last known version and digest are used instead. If the last known version is unavailable, then 'unknown' is used instead of the version.

Example: ubuntu:latest or ubuntu:latest@sha256:45b23dee08af5e43a7fea6c4cf9c25ccf269ee113168c19722f87876677c5cb2

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/artifacts/models/container_image.rb', line 38

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

[Required] Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


97
98
99
 
# File 'lib/oci/artifacts/models/container_image.rb', line 97

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the container image.

Example: ocid1.containerimage.oc1..exampleuniqueID

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/artifacts/models/container_image.rb', line 45

def id
  @id
end

#layers ⇒ Array<OCI::Artifacts::Models::ContainerImageLayer>

[Required] Layers of which the image is composed, ordered by the layer digest.

Returns:



49
50
51
 
# File 'lib/oci/artifacts/models/container_image.rb', line 49

def layers
  @layers
end

#layers_size_in_bytes ⇒ Integer

[Required] The total size of the container image layers in bytes.

Returns:

  • (Integer) 


53
54
55
 
# File 'lib/oci/artifacts/models/container_image.rb', line 53

def layers_size_in_bytes
  @layers_size_in_bytes
end

#lifecycle_state ⇒ String

[Required] The current state of the container image.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/artifacts/models/container_image.rb', line 57

def lifecycle_state
  @lifecycle_state
end

#manifest_size_in_bytes ⇒ Integer

[Required] The size of the container image manifest in bytes.

Returns:

  • (Integer) 


61
62
63
 
# File 'lib/oci/artifacts/models/container_image.rb', line 61

def manifest_size_in_bytes
  @manifest_size_in_bytes
end

#pull_count ⇒ Integer

[Required] Total number of pulls.

Returns:

  • (Integer) 


65
66
67
 
# File 'lib/oci/artifacts/models/container_image.rb', line 65

def pull_count
  @pull_count
end

#repository_id ⇒ String

[Required] The OCID of the container repository.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/artifacts/models/container_image.rb', line 69

def repository_id
  @repository_id
end

#repository_name ⇒ String

[Required] The container repository name.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/artifacts/models/container_image.rb', line 73

def repository_name
  @repository_name
end

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

[Required] The 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>>) 


111
112
113
 
# File 'lib/oci/artifacts/models/container_image.rb', line 111

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] An RFC 3339 timestamp indicating when the image was created.

Returns:

  • (DateTime) 


77
78
79
 
# File 'lib/oci/artifacts/models/container_image.rb', line 77

def time_created
  @time_created
end

#time_last_pulled ⇒ DateTime

An RFC 3339 timestamp indicating when the image was last pulled.

Returns:

  • (DateTime) 


81
82
83
 
# File 'lib/oci/artifacts/models/container_image.rb', line 81

def time_last_pulled
  @time_last_pulled
end

#version ⇒ String

The most recent version associated with this image.

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/artifacts/models/container_image.rb', line 85

def version
  @version
end

#versions ⇒ Array<OCI::Artifacts::Models::ContainerVersion>

[Required] The versions associated with this image.

Returns:



89
90
91
 
# File 'lib/oci/artifacts/models/container_image.rb', line 89

def versions
  @versions
end

Class Method Details

.attribute_map ⇒ Object

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



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/artifacts/models/container_image.rb', line 114

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'created_by': :'createdBy',
    'digest': :'digest',
    'display_name': :'displayName',
    'id': :'id',
    'layers': :'layers',
    'layers_size_in_bytes': :'layersSizeInBytes',
    'lifecycle_state': :'lifecycleState',
    'manifest_size_in_bytes': :'manifestSizeInBytes',
    'pull_count': :'pullCount',
    'repository_id': :'repositoryId',
    'repository_name': :'repositoryName',
    'time_created': :'timeCreated',
    'time_last_pulled': :'timeLastPulled',
    'version': :'version',
    'versions': :'versions',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/artifacts/models/container_image.rb', line 141

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'created_by': :'String',
    'digest': :'String',
    'display_name': :'String',
    'id': :'String',
    'layers': :'Array<OCI::Artifacts::Models::ContainerImageLayer>',
    'layers_size_in_bytes': :'Integer',
    'lifecycle_state': :'String',
    'manifest_size_in_bytes': :'Integer',
    'pull_count': :'Integer',
    'repository_id': :'String',
    'repository_name': :'String',
    'time_created': :'DateTime',
    'time_last_pulled': :'DateTime',
    'version': :'String',
    'versions': :'Array<OCI::Artifacts::Models::ContainerVersion>',
    '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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/oci/artifacts/models/container_image.rb', line 313

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    created_by == other.created_by &&
    digest == other.digest &&
    display_name == other.display_name &&
    id == other.id &&
    layers == other.layers &&
    layers_size_in_bytes == other.layers_size_in_bytes &&
    lifecycle_state == other.lifecycle_state &&
    manifest_size_in_bytes == other.manifest_size_in_bytes &&
    pull_count == other.pull_count &&
    repository_id == other.repository_id &&
    repository_name == other.repository_name &&
    time_created == other.time_created &&
    time_last_pulled == other.time_last_pulled &&
    version == other.version &&
    versions == other.versions &&
    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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/oci/artifacts/models/container_image.rb', line 361

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


341
342
343
 
# File 'lib/oci/artifacts/models/container_image.rb', line 341

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



350
351
352
 
# File 'lib/oci/artifacts/models/container_image.rb', line 350

def hash
  [compartment_id, created_by, digest, display_name, id, layers, layers_size_in_bytes, lifecycle_state, manifest_size_in_bytes, pull_count, repository_id, repository_name, time_created, time_last_pulled, version, versions, 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



394
395
396
397
398
399
400
401
402
403
 
# File 'lib/oci/artifacts/models/container_image.rb', line 394

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



388
389
390
 
# File 'lib/oci/artifacts/models/container_image.rb', line 388

def to_s
  to_hash.to_s
end