Class: OCI::ContainerInstances::Models::ContainerInstance

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/container_instances/models/container_instance.rb

Overview

A container instance to host containers.

If you delete a container instance, the record remains visible for a short period of time before being permanently removed.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.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
CONTAINER_RESTART_POLICY_ENUM = 
[
  CONTAINER_RESTART_POLICY_ALWAYS = 'ALWAYS'.freeze,
  CONTAINER_RESTART_POLICY_NEVER = 'NEVER'.freeze,
  CONTAINER_RESTART_POLICY_ON_FAILURE = 'ON_FAILURE'.freeze,
  CONTAINER_RESTART_POLICY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ContainerInstance

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 239

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

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

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

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

  self.availability_domain = attributes[:'availabilityDomain'] if attributes[:'availabilityDomain']

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

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

  self.fault_domain = attributes[:'faultDomain'] if attributes[:'faultDomain']

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

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

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

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

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

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

  self.volume_count = attributes[:'volumeCount'] if attributes[:'volumeCount']

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

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

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

  self.container_count = attributes[:'containerCount'] if attributes[:'containerCount']

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

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

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

  self.shape_config = attributes[:'shapeConfig'] if attributes[:'shapeConfig']

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

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

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

  self.dns_config = attributes[:'dnsConfig'] if attributes[:'dnsConfig']

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

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

  self.graceful_shutdown_timeout_in_seconds = attributes[:'gracefulShutdownTimeoutInSeconds'] if attributes[:'gracefulShutdownTimeoutInSeconds']

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

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

  self.image_pull_secrets = attributes[:'imagePullSecrets'] if attributes[:'imagePullSecrets']

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

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

  self.container_restart_policy = attributes[:'containerRestartPolicy'] if attributes[:'containerRestartPolicy']

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

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

  self.security_context = attributes[:'securityContext'] if attributes[:'securityContext']

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

  self.security_context = attributes[:'security_context'] if attributes[:'security_context']
end

Instance Attribute Details

#availability_domain ⇒ String

[Required] The availability domain to place the container instance.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 70

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 44

def compartment_id
  @compartment_id
end

#container_count ⇒ Integer

[Required] The number of containers on the container instance.

Returns:

  • (Integer) 


102
103
104
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 102

def container_count
  @container_count
end

#container_restart_policy ⇒ String

[Required] The container restart policy is applied for all containers in container instance.

Returns:

  • (String) 


137
138
139
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 137

def container_restart_policy
  @container_restart_policy
end

#containers ⇒ Array<OCI::ContainerInstances::Models::ContainerInstanceContainer>

[Required] The containers on the container instance.

Returns:



98
99
100
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 98

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


60
61
62
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 60

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 40

def display_name
  @display_name
end

#dns_config ⇒ OCI::ContainerInstances::Models::ContainerDnsConfig

Returns:



125
126
127
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 125

def dns_config
  @dns_config
end

#fault_domain ⇒ String

The fault domain to place the container instance.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 74

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


54
55
56
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 54

def freeform_tags
  @freeform_tags
end

#graceful_shutdown_timeout_in_seconds ⇒ Integer

The amount of time that processes in a container have to gracefully end when the container must be stopped. For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted.

Returns:

  • (Integer) 


129
130
131
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 129

def graceful_shutdown_timeout_in_seconds
  @graceful_shutdown_timeout_in_seconds
end

#id ⇒ String

[Required] An OCID that cannot be changed.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 36

def id
  @id
end

#image_pull_secrets ⇒ Array<OCI::ContainerInstances::Models::ImagePullSecret>

The image pulls secrets so you can access private registry to pull container images.

Returns:



133
134
135
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 133

def image_pull_secrets
  @image_pull_secrets
end

#lifecycle_details ⇒ String

A message that describes the current state of the container in more detail. Can be used to provide actionable information.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 84

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the container instance.

Returns:

  • (String) 


78
79
80
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 78

def lifecycle_state
  @lifecycle_state
end

#security_context ⇒ OCI::ContainerInstances::Models::ContainerInstanceSecurityContext

Returns:



140
141
142
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 140

def security_context
  @security_context
end

#shape ⇒ String

[Required] The shape of the container instance. The shape determines the number of OCPUs, amount of memory, and other resources that are allocated to a container instance.

Returns:

  • (String) 


114
115
116
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 114

def shape
  @shape
end

#shape_config ⇒ OCI::ContainerInstances::Models::ContainerInstanceShapeConfig

This attribute is required.

Returns:



118
119
120
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 118

def shape_config
  @shape_config
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}.

Returns:

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


66
67
68
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 66

def system_tags
  @system_tags
end

#tenant_id ⇒ String

TenantId id of the container instance.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 48

def tenant_id
  @tenant_id
end

#time_created ⇒ DateTime

[Required] The time the container instance was created, in the format defined by RFC 3339.

Returns:

  • (DateTime) 


106
107
108
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 106

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time the container instance was updated, in the format defined by RFC 3339.

Returns:

  • (DateTime) 


110
111
112
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 110

def time_updated
  @time_updated
end

#vnics ⇒ Array<OCI::ContainerInstances::Models::ContainerVnic>

[Required] The virtual networks available to the containers in the container instance.

Returns:



122
123
124
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 122

def vnics
  @vnics
end

#volume_count ⇒ Integer

The number of volumes that are attached to the container instance.

Returns:

  • (Integer) 


94
95
96
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 94

def volume_count
  @volume_count
end

#volumes ⇒ Array<OCI::ContainerInstances::Models::ContainerVolume>

A volume is a directory with data that is accessible across multiple containers in a container instance.

Returns:



90
91
92
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 90

def volumes
  @volumes
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 143

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'tenant_id': :'tenantId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'availability_domain': :'availabilityDomain',
    'fault_domain': :'faultDomain',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'volumes': :'volumes',
    'volume_count': :'volumeCount',
    'containers': :'containers',
    'container_count': :'containerCount',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'shape': :'shape',
    'shape_config': :'shapeConfig',
    'vnics': :'vnics',
    'dns_config': :'dnsConfig',
    'graceful_shutdown_timeout_in_seconds': :'gracefulShutdownTimeoutInSeconds',
    'image_pull_secrets': :'imagePullSecrets',
    'container_restart_policy': :'containerRestartPolicy',
    'security_context': :'securityContext'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
201
202
203
204
205
206
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 176

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'tenant_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'availability_domain': :'String',
    'fault_domain': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'volumes': :'Array<OCI::ContainerInstances::Models::ContainerVolume>',
    'volume_count': :'Integer',
    'containers': :'Array<OCI::ContainerInstances::Models::ContainerInstanceContainer>',
    'container_count': :'Integer',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'shape': :'String',
    'shape_config': :'OCI::ContainerInstances::Models::ContainerInstanceShapeConfig',
    'vnics': :'Array<OCI::ContainerInstances::Models::ContainerVnic>',
    'dns_config': :'OCI::ContainerInstances::Models::ContainerDnsConfig',
    'graceful_shutdown_timeout_in_seconds': :'Integer',
    'image_pull_secrets': :'Array<OCI::ContainerInstances::Models::ImagePullSecret>',
    'container_restart_policy': :'String',
    'security_context': :'OCI::ContainerInstances::Models::ContainerInstanceSecurityContext'
    # 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



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 409

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    tenant_id == other.tenant_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    availability_domain == other.availability_domain &&
    fault_domain == other.fault_domain &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    volumes == other.volumes &&
    volume_count == other.volume_count &&
    containers == other.containers &&
    container_count == other.container_count &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    shape == other.shape &&
    shape_config == other.shape_config &&
    vnics == other.vnics &&
    dns_config == other.dns_config &&
    graceful_shutdown_timeout_in_seconds == other.graceful_shutdown_timeout_in_seconds &&
    image_pull_secrets == other.image_pull_secrets &&
    container_restart_policy == other.container_restart_policy &&
    security_context == other.security_context
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



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 463

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


443
444
445
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 443

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



452
453
454
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 452

def hash
  [id, display_name, compartment_id, tenant_id, freeform_tags, defined_tags, system_tags, availability_domain, fault_domain, lifecycle_state, lifecycle_details, volumes, volume_count, containers, container_count, time_created, time_updated, shape, shape_config, vnics, dns_config, graceful_shutdown_timeout_in_seconds, image_pull_secrets, container_restart_policy, security_context].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



496
497
498
499
500
501
502
503
504
505
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 496

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



490
491
492
 
# File 'lib/oci/container_instances/models/container_instance.rb', line 490

def to_s
  to_hash.to_s
end