Class: ArgoWorkflows::IoK8sApiCoreV1Container

Inherits:
Object
  • Object
show all
Defined in:
lib/argo_workflows/models/io_k8s_api_core_v1_container.rb

Overview

A single application container that you want to run within a pod.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IoK8sApiCoreV1Container

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 152

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 }

  if attributes.has_key?(:'args')
    if (value = attributes[:'args']).is_a?(Array)
      self.args = value
    end
  end

  if attributes.has_key?(:'command')
    if (value = attributes[:'command']).is_a?(Array)
      self.command = value
    end
  end

  if attributes.has_key?(:'env')
    if (value = attributes[:'env']).is_a?(Array)
      self.env = value
    end
  end

  if attributes.has_key?(:'envFrom')
    if (value = attributes[:'envFrom']).is_a?(Array)
      self.env_from = value
    end
  end

  if attributes.has_key?(:'image')
    self.image = attributes[:'image']
  end

  if attributes.has_key?(:'imagePullPolicy')
    self.image_pull_policy = attributes[:'imagePullPolicy']
  end

  if attributes.has_key?(:'lifecycle')
    self.lifecycle = attributes[:'lifecycle']
  end

  if attributes.has_key?(:'livenessProbe')
    self.liveness_probe = attributes[:'livenessProbe']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'ports')
    if (value = attributes[:'ports']).is_a?(Array)
      self.ports = value
    end
  end

  if attributes.has_key?(:'readinessProbe')
    self.readiness_probe = attributes[:'readinessProbe']
  end

  if attributes.has_key?(:'resizePolicy')
    if (value = attributes[:'resizePolicy']).is_a?(Array)
      self.resize_policy = value
    end
  end

  if attributes.has_key?(:'resources')
    self.resources = attributes[:'resources']
  end

  if attributes.has_key?(:'restartPolicy')
    self.restart_policy = attributes[:'restartPolicy']
  end

  if attributes.has_key?(:'securityContext')
    self.security_context = attributes[:'securityContext']
  end

  if attributes.has_key?(:'startupProbe')
    self.startup_probe = attributes[:'startupProbe']
  end

  if attributes.has_key?(:'stdin')
    self.stdin = attributes[:'stdin']
  end

  if attributes.has_key?(:'stdinOnce')
    self.stdin_once = attributes[:'stdinOnce']
  end

  if attributes.has_key?(:'terminationMessagePath')
    self.termination_message_path = attributes[:'terminationMessagePath']
  end

  if attributes.has_key?(:'terminationMessagePolicy')
    self.termination_message_policy = attributes[:'terminationMessagePolicy']
  end

  if attributes.has_key?(:'tty')
    self.tty = attributes[:'tty']
  end

  if attributes.has_key?(:'volumeDevices')
    if (value = attributes[:'volumeDevices']).is_a?(Array)
      self.volume_devices = value
    end
  end

  if attributes.has_key?(:'volumeMounts')
    if (value = attributes[:'volumeMounts']).is_a?(Array)
      self.volume_mounts = value
    end
  end

  if attributes.has_key?(:'workingDir')
    self.working_dir = attributes[:'workingDir']
  end
end

Instance Attribute Details

#args ⇒ Object

Arguments to the entrypoint. The container image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell



19
20
21
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 19

def args
  @args
end

#command ⇒ Object

Entrypoint array. Not executed within a shell. The container image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell



22
23
24
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 22

def command
  @command
end

#env ⇒ Object

List of environment variables to set in the container. Cannot be updated.



25
26
27
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 25

def env
  @env
end

#env_from ⇒ Object

List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.



28
29
30
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 28

def env_from
  @env_from
end

#image ⇒ Object

Container image name. More info: kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.



31
32
33
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 31

def image
  @image
end

#image_pull_policy ⇒ Object

Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: kubernetes.io/docs/concepts/containers/images#updating-images



34
35
36
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 34

def image_pull_policy
  @image_pull_policy
end

#lifecycle ⇒ Object

Actions that the management system should take in response to container lifecycle events. Cannot be updated.



37
38
39
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 37

def lifecycle
  @lifecycle
end

#liveness_probe ⇒ Object

Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes



40
41
42
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 40

def liveness_probe
  @liveness_probe
end

#name ⇒ Object

Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.



43
44
45
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 43

def name
  @name
end

#ports ⇒ Object

List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default "0.0.0.0" address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.



46
47
48
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 46

def ports
  @ports
end

#readiness_probe ⇒ Object

Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes



49
50
51
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 49

def readiness_probe
  @readiness_probe
end

#resize_policy ⇒ Object

Resources resize policy for the container.



52
53
54
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 52

def resize_policy
  @resize_policy
end

#resources ⇒ Object

Compute Resources required by this container. Cannot be updated. More info: kubernetes.io/docs/concepts/configuration/manage-resources-containers/



55
56
57
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 55

def resources
  @resources
end

#restart_policy ⇒ Object

RestartPolicy defines the restart behavior of individual containers in a pod. This field may only be set for init containers, and the only allowed value is "Always". For non-init containers or when this field is not specified, the restart behavior is defined by the Pod’s restart policy and the container type. Setting the RestartPolicy as "Always" for the init container will have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" will be shut down. This lifecycle differs from normal init containers and is often referred to as a "sidecar" container. Although this init container still starts in the init container sequence, it does not wait for the container to complete before proceeding to the next init container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed.



58
59
60
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 58

def restart_policy
  @restart_policy
end

#security_context ⇒ Object

SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: kubernetes.io/docs/tasks/configure-pod-container/security-context/



61
62
63
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 61

def security_context
  @security_context
end

#startup_probe ⇒ Object

StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes



64
65
66
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 64

def startup_probe
  @startup_probe
end

#stdin ⇒ Object

Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.



67
68
69
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 67

def stdin
  @stdin
end

#stdin_once ⇒ Object

Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false



70
71
72
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 70

def stdin_once
  @stdin_once
end

#termination_message_path ⇒ Object

Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.



73
74
75
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 73

def termination_message_path
  @termination_message_path
end

#termination_message_policy ⇒ Object

Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.



76
77
78
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 76

def termination_message_policy
  @termination_message_policy
end

#tty ⇒ Object

Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false.



79
80
81
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 79

def tty
  @tty
end

#volume_devices ⇒ Object

volumeDevices is the list of block devices to be used by the container.



82
83
84
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 82

def volume_devices
  @volume_devices
end

#volume_mounts ⇒ Object

Pod volumes to mount into the container’s filesystem. Cannot be updated.



85
86
87
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 85

def volume_mounts
  @volume_mounts
end

#working_dir ⇒ Object

Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.



88
89
90
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 88

def working_dir
  @working_dir
end

Class Method Details

.attribute_map ⇒ Object

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 91

def self.attribute_map
  {
    :'args' => :'args',
    :'command' => :'command',
    :'env' => :'env',
    :'env_from' => :'envFrom',
    :'image' => :'image',
    :'image_pull_policy' => :'imagePullPolicy',
    :'lifecycle' => :'lifecycle',
    :'liveness_probe' => :'livenessProbe',
    :'name' => :'name',
    :'ports' => :'ports',
    :'readiness_probe' => :'readinessProbe',
    :'resize_policy' => :'resizePolicy',
    :'resources' => :'resources',
    :'restart_policy' => :'restartPolicy',
    :'security_context' => :'securityContext',
    :'startup_probe' => :'startupProbe',
    :'stdin' => :'stdin',
    :'stdin_once' => :'stdinOnce',
    :'termination_message_path' => :'terminationMessagePath',
    :'termination_message_policy' => :'terminationMessagePolicy',
    :'tty' => :'tty',
    :'volume_devices' => :'volumeDevices',
    :'volume_mounts' => :'volumeMounts',
    :'working_dir' => :'workingDir'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 121

def self.swagger_types
  {
    :'args' => :'Array<String>',
    :'command' => :'Array<String>',
    :'env' => :'Array<IoK8sApiCoreV1EnvVar>',
    :'env_from' => :'Array<IoK8sApiCoreV1EnvFromSource>',
    :'image' => :'String',
    :'image_pull_policy' => :'String',
    :'lifecycle' => :'IoK8sApiCoreV1Lifecycle',
    :'liveness_probe' => :'IoK8sApiCoreV1Probe',
    :'name' => :'String',
    :'ports' => :'Array<IoK8sApiCoreV1ContainerPort>',
    :'readiness_probe' => :'IoK8sApiCoreV1Probe',
    :'resize_policy' => :'Array<IoK8sApiCoreV1ContainerResizePolicy>',
    :'resources' => :'IoK8sApiCoreV1ResourceRequirements',
    :'restart_policy' => :'String',
    :'security_context' => :'IoK8sApiCoreV1SecurityContext',
    :'startup_probe' => :'IoK8sApiCoreV1Probe',
    :'stdin' => :'BOOLEAN',
    :'stdin_once' => :'BOOLEAN',
    :'termination_message_path' => :'String',
    :'termination_message_policy' => :'String',
    :'tty' => :'BOOLEAN',
    :'volume_devices' => :'Array<IoK8sApiCoreV1VolumeDevice>',
    :'volume_mounts' => :'Array<IoK8sApiCoreV1VolumeMount>',
    :'working_dir' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 291

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      args == o.args &&
      command == o.command &&
      env == o.env &&
      env_from == o.env_from &&
      image == o.image &&
      image_pull_policy == o.image_pull_policy &&
      lifecycle == o.lifecycle &&
      liveness_probe == o.liveness_probe &&
      name == o.name &&
      ports == o.ports &&
      readiness_probe == o.readiness_probe &&
      resize_policy == o.resize_policy &&
      resources == o.resources &&
      restart_policy == o.restart_policy &&
      security_context == o.security_context &&
      startup_probe == o.startup_probe &&
      stdin == o.stdin &&
      stdin_once == o.stdin_once &&
      termination_message_path == o.termination_message_path &&
      termination_message_policy == o.termination_message_policy &&
      tty == o.tty &&
      volume_devices == o.volume_devices &&
      volume_mounts == o.volume_mounts &&
      working_dir == o.working_dir
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 356

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = ArgoWorkflows.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 422

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 335

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(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?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


322
323
324
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 322

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



328
329
330
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 328

def hash
  [args, command, env, env_from, image, image_pull_policy, lifecycle, liveness_probe, name, ports, readiness_probe, resize_policy, resources, restart_policy, security_context, startup_probe, stdin, stdin_once, termination_message_path, termination_message_policy, tty, volume_devices, volume_mounts, working_dir].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



273
274
275
276
277
278
279
280
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 273

def list_invalid_properties
  invalid_properties = Array.new
  if @image.nil?
    invalid_properties.push('invalid value for "image", image cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



402
403
404
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 402

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



408
409
410
411
412
413
414
415
416
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 408

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



396
397
398
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 396

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



284
285
286
287
 
# File 'lib/argo_workflows/models/io_k8s_api_core_v1_container.rb', line 284

def valid?
  return false if @image.nil?
  true
end