Class: OCI::ContainerInstances::Models::ContainerSummary
- Inherits:
-
Object
- Object
- OCI::ContainerInstances::Models::ContainerSummary
- Defined in:
- lib/oci/container_instances/models/container_summary.rb
Overview
Summary information about a container.
Instance Attribute Summary collapse
-
#availability_domain ⇒ String
[Required] The availability domain where the container instance that hosts this container runs.
-
#compartment_id ⇒ String
[Required] The compartment OCID.
-
#container_instance_id ⇒ String
[Required] The OCID of the container instance on which the container is running.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
[Required] A user-friendly name.
-
#fault_domain ⇒ String
The fault domain where the container instance that hosts the container runs.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
[Required] The OCID of the container.
-
#image_url ⇒ String
[Required] A URL identifying the image that the container runs in, such as docker.io/library/busybox:latest.
-
#is_resource_principal_disabled ⇒ BOOLEAN
Determines whether the container will have access to the container instance resource principal.
-
#lifecycle_details ⇒ String
A message that describes the current state of the container in more detail.
-
#lifecycle_state ⇒ String
[Required] The current state of the container.
- #resource_config ⇒ OCI::ContainerInstances::Models::ContainerResourceConfig
- #security_context ⇒ OCI::ContainerInstances::Models::SecurityContext
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
Usage of system tag keys.
-
#time_created ⇒ DateTime
[Required] The time the the container was created in the format defined by RFC 3339.
-
#time_updated ⇒ DateTime
The time the container was updated in the format defined by RFC 3339.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ ContainerSummary
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ ContainerSummary
Initializes the object
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 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 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 167 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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self. = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self. = 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.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.container_instance_id = attributes[:'containerInstanceId'] if attributes[:'containerInstanceId'] raise 'You cannot provide both :containerInstanceId and :container_instance_id' if attributes.key?(:'containerInstanceId') && attributes.key?(:'container_instance_id') self.container_instance_id = attributes[:'container_instance_id'] if attributes[:'container_instance_id'] self.resource_config = attributes[:'resourceConfig'] if attributes[:'resourceConfig'] raise 'You cannot provide both :resourceConfig and :resource_config' if attributes.key?(:'resourceConfig') && attributes.key?(:'resource_config') self.resource_config = attributes[:'resource_config'] if attributes[:'resource_config'] self.image_url = attributes[:'imageUrl'] if attributes[:'imageUrl'] raise 'You cannot provide both :imageUrl and :image_url' if attributes.key?(:'imageUrl') && attributes.key?(:'image_url') self.image_url = attributes[:'image_url'] if attributes[:'image_url'] self.is_resource_principal_disabled = attributes[:'isResourcePrincipalDisabled'] unless attributes[:'isResourcePrincipalDisabled'].nil? raise 'You cannot provide both :isResourcePrincipalDisabled and :is_resource_principal_disabled' if attributes.key?(:'isResourcePrincipalDisabled') && attributes.key?(:'is_resource_principal_disabled') self.is_resource_principal_disabled = attributes[:'is_resource_principal_disabled'] unless attributes[:'is_resource_principal_disabled'].nil? 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 where the container instance that hosts this container runs.
44 45 46 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 44 def availability_domain @availability_domain end |
#compartment_id ⇒ String
[Required] The compartment OCID.
22 23 24 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 22 def compartment_id @compartment_id end |
#container_instance_id ⇒ String
[Required] The OCID of the container instance on which the container is running.
70 71 72 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 70 def container_instance_id @container_instance_id 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\"}}
.
34 35 36 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 34 def @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.
18 19 20 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 18 def display_name @display_name end |
#fault_domain ⇒ String
The fault domain where the container instance that hosts the container runs.
48 49 50 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 48 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\"}
28 29 30 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 28 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the container.
14 15 16 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 14 def id @id end |
#image_url ⇒ String
[Required] A URL identifying the image that the container runs in, such as docker.io/library/busybox:latest. If you do not provide a tag, the tag will default to latest.
If no registry is provided, will default the registry to public docker hub docker.io/library
. The registry used for container image must be reachable over the Container Instance's VNIC.
81 82 83 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 81 def image_url @image_url end |
#is_resource_principal_disabled ⇒ BOOLEAN
Determines whether the container will have access to the container instance resource principal.
This method utilizes resource principal version 2.2. For information on how to use the exposed resource principal elements, see docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal.
89 90 91 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 89 def is_resource_principal_disabled @is_resource_principal_disabled end |
#lifecycle_details ⇒ String
A message that describes the current state of the container in more detail. Can be used to provide actionable information.
58 59 60 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 58 def lifecycle_details @lifecycle_details end |
#lifecycle_state ⇒ String
[Required] The current state of the container.
52 53 54 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 52 def lifecycle_state @lifecycle_state end |
#resource_config ⇒ OCI::ContainerInstances::Models::ContainerResourceConfig
73 74 75 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 73 def resource_config @resource_config end |
#security_context ⇒ OCI::ContainerInstances::Models::SecurityContext
92 93 94 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 92 def security_context @security_context 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\"}}
.
40 41 42 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 40 def @system_tags end |
#time_created ⇒ DateTime
[Required] The time the the container was created in the format defined by RFC 3339.
62 63 64 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 62 def time_created @time_created end |
#time_updated ⇒ DateTime
The time the container was updated in the format defined by RFC 3339.
66 67 68 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 66 def time_updated @time_updated end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 95 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'compartment_id': :'compartmentId', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags', 'availability_domain': :'availabilityDomain', 'fault_domain': :'faultDomain', 'lifecycle_state': :'lifecycleState', 'lifecycle_details': :'lifecycleDetails', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'container_instance_id': :'containerInstanceId', 'resource_config': :'resourceConfig', 'image_url': :'imageUrl', 'is_resource_principal_disabled': :'isResourcePrincipalDisabled', 'security_context': :'securityContext' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 120 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'compartment_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', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'container_instance_id': :'String', 'resource_config': :'OCI::ContainerInstances::Models::ContainerResourceConfig', 'image_url': :'String', 'is_resource_principal_disabled': :'BOOLEAN', 'security_context': :'OCI::ContainerInstances::Models::SecurityContext' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 279 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && display_name == other.display_name && compartment_id == other.compartment_id && == other. && == other. && == other. && availability_domain == other.availability_domain && fault_domain == other.fault_domain && lifecycle_state == other.lifecycle_state && lifecycle_details == other.lifecycle_details && time_created == other.time_created && time_updated == other.time_updated && container_instance_id == other.container_instance_id && resource_config == other.resource_config && image_url == other.image_url && is_resource_principal_disabled == other.is_resource_principal_disabled && security_context == other.security_context end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 325 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
305 306 307 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 305 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
314 315 316 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 314 def hash [id, display_name, compartment_id, , , , availability_domain, fault_domain, lifecycle_state, lifecycle_details, time_created, time_updated, container_instance_id, resource_config, image_url, is_resource_principal_disabled, security_context].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
358 359 360 361 362 363 364 365 366 367 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 358 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
352 353 354 |
# File 'lib/oci/container_instances/models/container_summary.rb', line 352 def to_s to_hash.to_s end |