Class: OCI::Artifacts::Models::ContainerImageSummary

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

Overview

Container image summary.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ContainerImageSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :digest (String) —

    The value to assign to the #digest property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :id (String) —

    The value to assign to the #id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :repository_id (String) —

    The value to assign to the #repository_id property

  • :repository_name (String) —

    The value to assign to the #repository_name property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :version (String) —

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



135
136
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
162
163
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
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 135

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

  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) 


13
14
15
 
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 13

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


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

def defined_tags
  @defined_tags
end

#digest ⇒ String

[Required] The container image digest.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 17

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) 


26
27
28
 
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 26

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the container image.

Example: ocid1.containerimage.oc1..exampleuniqueID

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 33

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the container image.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 37

def lifecycle_state
  @lifecycle_state
end

#repository_id ⇒ String

[Required] The OCID of the container repository.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 41

def repository_id
  @repository_id
end

#repository_name ⇒ String

[Required] The container repository name.

Returns:

  • (String) 


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

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


75
76
77
 
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 75

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#version ⇒ String

The most recent version associated with this image.

Returns:

  • (String) 


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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 78

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'digest': :'digest',
    'display_name': :'displayName',
    'id': :'id',
    'lifecycle_state': :'lifecycleState',
    'repository_id': :'repositoryId',
    'repository_name': :'repositoryName',
    'time_created': :'timeCreated',
    'version': :'version',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 98

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'digest': :'String',
    'display_name': :'String',
    'id': :'String',
    'lifecycle_state': :'String',
    'repository_id': :'String',
    'repository_name': :'String',
    'time_created': :'DateTime',
    'version': :'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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 209

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    digest == other.digest &&
    display_name == other.display_name &&
    id == other.id &&
    lifecycle_state == other.lifecycle_state &&
    repository_id == other.repository_id &&
    repository_name == other.repository_name &&
    time_created == other.time_created &&
    version == other.version &&
    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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 250

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


230
231
232
 
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 230

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



239
240
241
 
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 239

def hash
  [compartment_id, digest, display_name, id, lifecycle_state, repository_id, repository_name, time_created, version, 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



283
284
285
286
287
288
289
290
291
292
 
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 283

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



277
278
279
 
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 277

def to_s
  to_hash.to_s
end