Class: OCI::Artifacts::Models::ContainerRepository

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

Overview

Container repository metadata.

Constant Summary collapse

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

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

  • :created_by (String) —

    The value to assign to the #created_by property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :id (String) —

    The value to assign to the #id property

  • :image_count (Integer) —

    The value to assign to the #image_count property

  • :is_immutable (BOOLEAN) —

    The value to assign to the #is_immutable property

  • :is_public (BOOLEAN) —

    The value to assign to the #is_public property

  • :layer_count (Integer) —

    The value to assign to the #layer_count property

  • :layers_size_in_bytes (Integer) —

    The value to assign to the #layers_size_in_bytes property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :readme (OCI::Artifacts::Models::ContainerRepositoryReadme) —

    The value to assign to the #readme property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_last_pushed (DateTime) —

    The value to assign to the #time_last_pushed property

  • :billable_size_in_gbs (Integer) —

    The value to assign to the #billable_size_in_gbs property

  • :namespace (String) —

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



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

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

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

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

  self.is_immutable = attributes[:'isImmutable'] unless attributes[:'isImmutable'].nil?

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

  self.is_immutable = attributes[:'is_immutable'] unless attributes[:'is_immutable'].nil?

  self.is_public = attributes[:'isPublic'] unless attributes[:'isPublic'].nil?

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

  self.is_public = attributes[:'is_public'] unless attributes[:'is_public'].nil?

  self.layer_count = attributes[:'layerCount'] if attributes[:'layerCount']

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

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

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

  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_pushed = attributes[:'timeLastPushed'] if attributes[:'timeLastPushed']

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

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

  self.billable_size_in_gbs = attributes[:'billableSizeInGBs'] if attributes[:'billableSizeInGBs']

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

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

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

  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

#billable_size_in_gbs ⇒ Integer

[Required] Total storage size in GBs that will be charged.

Returns:

  • (Integer) 


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

def billable_size_in_gbs
  @billable_size_in_gbs
end

#compartment_id ⇒ String

[Required] The OCID of the compartment in which the container repository exists.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#created_by ⇒ String

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

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/artifacts/models/container_repository.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>>) 


95
96
97
 
# File 'lib/oci/artifacts/models/container_repository.rb', line 95

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The container repository name.

Returns:

  • (String) 


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

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


87
88
89
 
# File 'lib/oci/artifacts/models/container_repository.rb', line 87

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the container repository.

Example: ocid1.containerrepo.oc1..exampleuniqueID

Returns:

  • (String) 


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

def id
  @id
end

#image_count ⇒ Integer

[Required] Total number of images.

Returns:

  • (Integer) 


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

def image_count
  @image_count
end

#is_immutable ⇒ BOOLEAN

[Required] Whether the repository is immutable. Images cannot be overwritten in an immutable repository.

Returns:

  • (BOOLEAN) 


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

def is_immutable
  @is_immutable
end

#is_public ⇒ BOOLEAN

[Required] Whether the repository is public. A public repository allows unauthenticated access.

Returns:

  • (BOOLEAN) 


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

def is_public
  @is_public
end

#layer_count ⇒ Integer

[Required] Total number of layers.

Returns:

  • (Integer) 


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

def layer_count
  @layer_count
end

#layers_size_in_bytes ⇒ Integer

[Required] Total storage in bytes consumed by layers.

Returns:

  • (Integer) 


56
57
58
 
# File 'lib/oci/artifacts/models/container_repository.rb', line 56

def layers_size_in_bytes
  @layers_size_in_bytes
end

#lifecycle_state ⇒ String

[Required] The current state of the container repository.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/artifacts/models/container_repository.rb', line 60

def lifecycle_state
  @lifecycle_state
end

#namespace ⇒ String

[Required] The tenancy namespace used in the container repository path.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/artifacts/models/container_repository.rb', line 79

def namespace
  @namespace
end

#readme ⇒ OCI::Artifacts::Models::ContainerRepositoryReadme

Returns:



63
64
65
 
# File 'lib/oci/artifacts/models/container_repository.rb', line 63

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


101
102
103
 
# File 'lib/oci/artifacts/models/container_repository.rb', line 101

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


67
68
69
 
# File 'lib/oci/artifacts/models/container_repository.rb', line 67

def time_created
  @time_created
end

#time_last_pushed ⇒ DateTime

An RFC 3339 timestamp indicating when an image was last pushed to the repository.

Returns:

  • (DateTime) 


71
72
73
 
# File 'lib/oci/artifacts/models/container_repository.rb', line 71

def time_last_pushed
  @time_last_pushed
end

Class Method Details

.attribute_map ⇒ Object

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/artifacts/models/container_repository.rb', line 104

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'created_by': :'createdBy',
    'display_name': :'displayName',
    'id': :'id',
    'image_count': :'imageCount',
    'is_immutable': :'isImmutable',
    'is_public': :'isPublic',
    'layer_count': :'layerCount',
    'layers_size_in_bytes': :'layersSizeInBytes',
    'lifecycle_state': :'lifecycleState',
    'readme': :'readme',
    'time_created': :'timeCreated',
    'time_last_pushed': :'timeLastPushed',
    'billable_size_in_gbs': :'billableSizeInGBs',
    'namespace': :'namespace',
    '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
149
150
151
152
153
 
# File 'lib/oci/artifacts/models/container_repository.rb', line 130

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'created_by': :'String',
    'display_name': :'String',
    'id': :'String',
    'image_count': :'Integer',
    'is_immutable': :'BOOLEAN',
    'is_public': :'BOOLEAN',
    'layer_count': :'Integer',
    'layers_size_in_bytes': :'Integer',
    'lifecycle_state': :'String',
    'readme': :'OCI::Artifacts::Models::ContainerRepositoryReadme',
    'time_created': :'DateTime',
    'time_last_pushed': :'DateTime',
    'billable_size_in_gbs': :'Integer',
    'namespace': :'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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/oci/artifacts/models/container_repository.rb', line 302

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    created_by == other.created_by &&
    display_name == other.display_name &&
    id == other.id &&
    image_count == other.image_count &&
    is_immutable == other.is_immutable &&
    is_public == other.is_public &&
    layer_count == other.layer_count &&
    layers_size_in_bytes == other.layers_size_in_bytes &&
    lifecycle_state == other.lifecycle_state &&
    readme == other.readme &&
    time_created == other.time_created &&
    time_last_pushed == other.time_last_pushed &&
    billable_size_in_gbs == other.billable_size_in_gbs &&
    namespace == other.namespace &&
    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



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/oci/artifacts/models/container_repository.rb', line 349

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


329
330
331
 
# File 'lib/oci/artifacts/models/container_repository.rb', line 329

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



338
339
340
 
# File 'lib/oci/artifacts/models/container_repository.rb', line 338

def hash
  [compartment_id, created_by, display_name, id, image_count, is_immutable, is_public, layer_count, layers_size_in_bytes, lifecycle_state, readme, time_created, time_last_pushed, billable_size_in_gbs, namespace, 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



382
383
384
385
386
387
388
389
390
391
 
# File 'lib/oci/artifacts/models/container_repository.rb', line 382

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



376
377
378
 
# File 'lib/oci/artifacts/models/container_repository.rb', line 376

def to_s
  to_hash.to_s
end