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



103
104
105
106
107
108
109
110
111
112
113
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
139
140
141
142
143
144
145
146
147
148
149
150
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 103

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']
end

Instance Attribute Details

#compartment_idString

[Required] The compartment OCID to which the container image belongs. Inferred from the container repository.

Returns:

  • (String)


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

def compartment_id
  @compartment_id
end

#digestString

[Required] The container image digest.

Returns:

  • (String)


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

def digest
  @digest
end

#display_nameString

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


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

def display_name
  @display_name
end

#idString

[Required] The OCID of the container image.

Example: ocid1.containerimage.oc1..exampleuniqueID

Returns:

  • (String)


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

def id
  @id
end

#lifecycle_stateString

[Required] The current state of the container image.

Returns:

  • (String)


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

def lifecycle_state
  @lifecycle_state
end

#repository_idString

[Required] The OCID of the container repository.

Returns:

  • (String)


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

def repository_id
  @repository_id
end

#repository_nameString

[Required] The container repository name.

Returns:

  • (String)


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

def repository_name
  @repository_name
end

#time_createdDateTime

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

Returns:

  • (DateTime)


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

def time_created
  @time_created
end

#versionString

The most recent version associated with this image.

Returns:

  • (String)


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

def version
  @version
end

Class Method Details

.attribute_mapObject

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 55

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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 72

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'
    # 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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 159

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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 197

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


177
178
179
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 177

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



186
187
188
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 186

def hash
  [compartment_id, digest, display_name, id, lifecycle_state, repository_id, repository_name, time_created, version].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



230
231
232
233
234
235
236
237
238
239
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 230

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



224
225
226
# File 'lib/oci/artifacts/models/container_image_summary.rb', line 224

def to_s
  to_hash.to_s
end