Class: OCI::ContainerInstances::Models::CreateContainerInstanceDetails
- Inherits:
-
Object
- Object
- OCI::ContainerInstances::Models::CreateContainerInstanceDetails
- Defined in:
- lib/oci/container_instances/models/create_container_instance_details.rb
Overview
Information to create a container instance.
Instance Attribute Summary collapse
-
#availability_domain ⇒ String
[Required] The availability domain where the container instance runs.
-
#compartment_id ⇒ String
[Required] The compartment OCID.
-
#container_restart_policy ⇒ String
Container restart policy.
-
#containers ⇒ Array<OCI::ContainerInstances::Models::CreateContainerDetails>
[Required] The containers to create on this container instance.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
A user-friendly name.
- #dns_config ⇒ OCI::ContainerInstances::Models::CreateContainerDnsConfigDetails
-
#fault_domain ⇒ String
The fault domain where the container instance runs.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#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.
-
#image_pull_secrets ⇒ Array<OCI::ContainerInstances::Models::CreateImagePullSecretDetails>
The image pulls secrets so you can access private registry to pull container images.
-
#shape ⇒ String
[Required] The shape of the container instance.
-
#shape_config ⇒ OCI::ContainerInstances::Models::CreateContainerInstanceShapeConfigDetails
This attribute is required.
-
#vnics ⇒ Array<OCI::ContainerInstances::Models::CreateContainerVnicDetails>
[Required] The networks available to containers on this container instance.
-
#volumes ⇒ Array<OCI::ContainerInstances::Models::CreateContainerVolumeDetails>
A volume is a directory with data that is accessible across multiple containers in a container instance.
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 = {}) ⇒ CreateContainerInstanceDetails
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 = {}) ⇒ CreateContainerInstanceDetails
Initializes the object
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 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 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 147 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.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.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.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.volumes = attributes[:'volumes'] if attributes[:'volumes'] self.containers = attributes[:'containers'] if attributes[:'containers'] 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'] self.graceful_shutdown_timeout_in_seconds = 0 if graceful_shutdown_timeout_in_seconds.nil? && !attributes.key?(:'gracefulShutdownTimeoutInSeconds') # rubocop:disable Style/StringLiterals 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.graceful_shutdown_timeout_in_seconds = 0 if graceful_shutdown_timeout_in_seconds.nil? && !attributes.key?(:'gracefulShutdownTimeoutInSeconds') && !attributes.key?(:'graceful_shutdown_timeout_in_seconds') # rubocop:disable Style/StringLiterals 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'] self.container_restart_policy = "ALWAYS" if container_restart_policy.nil? && !attributes.key?(:'containerRestartPolicy') # rubocop:disable Style/StringLiterals 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.container_restart_policy = "ALWAYS" if container_restart_policy.nil? && !attributes.key?(:'containerRestartPolicy') && !attributes.key?(:'container_restart_policy') # rubocop:disable Style/StringLiterals 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'] end |
Instance Attribute Details
#availability_domain ⇒ String
[Required] The availability domain where the container instance runs.
22 23 24 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 22 def availability_domain @availability_domain end |
#compartment_id ⇒ String
[Required] The compartment OCID.
18 19 20 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 18 def compartment_id @compartment_id end |
#container_restart_policy ⇒ String
Container restart policy
66 67 68 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 66 def container_restart_policy @container_restart_policy end |
#containers ⇒ Array<OCI::ContainerInstances::Models::CreateContainerDetails>
[Required] The containers to create on this container instance.
47 48 49 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 47 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\"}}
.
78 79 80 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 78 def @defined_tags end |
#display_name ⇒ String
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
14 15 16 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 14 def display_name @display_name end |
#dns_config ⇒ OCI::ContainerInstances::Models::CreateContainerDnsConfigDetails
54 55 56 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 54 def dns_config @dns_config end |
#fault_domain ⇒ String
The fault domain where the container instance runs.
27 28 29 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 27 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\"}
72 73 74 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 72 def @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.
58 59 60 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 58 def graceful_shutdown_timeout_in_seconds @graceful_shutdown_timeout_in_seconds end |
#image_pull_secrets ⇒ Array<OCI::ContainerInstances::Models::CreateImagePullSecretDetails>
The image pulls secrets so you can access private registry to pull container images.
62 63 64 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 62 def image_pull_secrets @image_pull_secrets end |
#shape ⇒ String
[Required] The shape of the container instance. The shape determines the resources available to the container instance.
31 32 33 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 31 def shape @shape end |
#shape_config ⇒ OCI::ContainerInstances::Models::CreateContainerInstanceShapeConfigDetails
This attribute is required.
35 36 37 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 35 def shape_config @shape_config end |
#vnics ⇒ Array<OCI::ContainerInstances::Models::CreateContainerVnicDetails>
[Required] The networks available to containers on this container instance.
51 52 53 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 51 def vnics @vnics end |
#volumes ⇒ Array<OCI::ContainerInstances::Models::CreateContainerVolumeDetails>
A volume is a directory with data that is accessible across multiple containers in a container instance.
You can attach up to 32 volumes to single container instance.
43 44 45 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 43 def volumes @volumes end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 81 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'display_name': :'displayName', 'compartment_id': :'compartmentId', 'availability_domain': :'availabilityDomain', 'fault_domain': :'faultDomain', 'shape': :'shape', 'shape_config': :'shapeConfig', 'volumes': :'volumes', 'containers': :'containers', 'vnics': :'vnics', 'dns_config': :'dnsConfig', 'graceful_shutdown_timeout_in_seconds': :'gracefulShutdownTimeoutInSeconds', 'image_pull_secrets': :'imagePullSecrets', 'container_restart_policy': :'containerRestartPolicy', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 104 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'display_name': :'String', 'compartment_id': :'String', 'availability_domain': :'String', 'fault_domain': :'String', 'shape': :'String', 'shape_config': :'OCI::ContainerInstances::Models::CreateContainerInstanceShapeConfigDetails', 'volumes': :'Array<OCI::ContainerInstances::Models::CreateContainerVolumeDetails>', 'containers': :'Array<OCI::ContainerInstances::Models::CreateContainerDetails>', 'vnics': :'Array<OCI::ContainerInstances::Models::CreateContainerVnicDetails>', 'dns_config': :'OCI::ContainerInstances::Models::CreateContainerDnsConfigDetails', 'graceful_shutdown_timeout_in_seconds': :'Integer', 'image_pull_secrets': :'Array<OCI::ContainerInstances::Models::CreateImagePullSecretDetails>', 'container_restart_policy': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 239 def ==(other) return true if equal?(other) self.class == other.class && display_name == other.display_name && compartment_id == other.compartment_id && availability_domain == other.availability_domain && fault_domain == other.fault_domain && shape == other.shape && shape_config == other.shape_config && volumes == other.volumes && containers == other.containers && 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 && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 283 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
263 264 265 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 263 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
272 273 274 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 272 def hash [display_name, compartment_id, availability_domain, fault_domain, shape, shape_config, volumes, containers, vnics, dns_config, graceful_shutdown_timeout_in_seconds, image_pull_secrets, container_restart_policy, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
316 317 318 319 320 321 322 323 324 325 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 316 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
310 311 312 |
# File 'lib/oci/container_instances/models/create_container_instance_details.rb', line 310 def to_s to_hash.to_s end |