Class: DockerEngineRuby::Models::TaskSpec::ContainerSpec

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/docker_engine_ruby/models/task_spec.rb,
sig/docker_engine_ruby/models/task_spec.rbs

Overview

See Also:

  • DockerEngineRuby::Models::TaskSpec#container_spec

Defined Under Namespace

Modules: Isolation Classes: Config, DNSConfig, HealthCheck, Mount, Privileges, Secret, Ulimit

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(gid: nil, mode: nil, name: nil, uid: nil) ⇒ Object

Parameters:

  • gid (String) (defaults to: nil)
  • mode (Integer) (defaults to: nil)
  • name (String) (defaults to: nil)
  • uid (String) (defaults to: nil) 



# File 'lib/docker_engine_ruby/models/task_spec.rb', line 411

Instance Attribute Details

#args ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


123
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 123

optional :args, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Args

#capability_add ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


128
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 128

optional :capability_add, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :CapabilityAdd

#capability_drop ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


133
134
135
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 133

optional :capability_drop,
DockerEngineRuby::Internal::Type::ArrayOf[String],
api_name: :CapabilityDrop

#command ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


140
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 140

optional :command, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Command

#configs ⇒ Array<DockerEngineRuby::Models::TaskSpec::ContainerSpec::Config>?

Returns:



145
146
147
148
149
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 145

optional :configs,
-> {
  DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::TaskSpec::ContainerSpec::Config]
},
api_name: :Configs

#dir ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


154
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 154

optional :dir, String, api_name: :Dir

#dns_config ⇒ DockerEngineRuby::Models::TaskSpec::ContainerSpec::DNSConfig?

Returns:



159
160
161
162
163
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 159

optional :dns_config,
-> {
  DockerEngineRuby::TaskSpec::ContainerSpec::DNSConfig
},
api_name: :DNSConfig

#env ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


168
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 168

optional :env, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Env

#groups ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


173
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 173

optional :groups, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Groups

#health_check ⇒ DockerEngineRuby::Models::TaskSpec::ContainerSpec::HealthCheck?

A test to perform to check that the container is healthy. Healthcheck commands should be side-effect free.

Returns:



180
181
182
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 180

optional :health_check,
-> { DockerEngineRuby::TaskSpec::ContainerSpec::HealthCheck },
api_name: :HealthCheck

#hostname ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


187
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 187

optional :hostname, String, api_name: :Hostname

#hosts ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


192
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 192

optional :hosts, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Hosts

#image ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


197
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 197

optional :image, String, api_name: :Image

#init ⇒ Boolean?

Parameters:

  • value (Boolean, nil)

Returns:

  • (Boolean, nil) 


202
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 202

optional :init, DockerEngineRuby::Internal::Type::Boolean, api_name: :Init, nil?: true

#isolation ⇒ Symbol, ...

Returns:



207
208
209
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 207

optional :isolation,
enum: -> { DockerEngineRuby::TaskSpec::ContainerSpec::Isolation },
api_name: :Isolation

#labels ⇒ Hash{Symbol=>String}?

Parameters:

  • (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}, nil) 


214
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 214

optional :labels, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Labels

#mounts ⇒ Array<DockerEngineRuby::Models::TaskSpec::ContainerSpec::Mount>?

Returns:



219
220
221
222
223
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 219

optional :mounts,
-> {
  DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::TaskSpec::ContainerSpec::Mount]
},
api_name: :Mounts

#oom_score_adj ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


228
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 228

optional :oom_score_adj, Integer, api_name: :OomScoreAdj

#open_stdin ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


233
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 233

optional :open_stdin, DockerEngineRuby::Internal::Type::Boolean, api_name: :OpenStdin

#privileges ⇒ DockerEngineRuby::Models::TaskSpec::ContainerSpec::Privileges?

Returns:



238
239
240
241
242
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 238

optional :privileges,
-> {
  DockerEngineRuby::TaskSpec::ContainerSpec::Privileges
},
api_name: :Privileges

#read_only ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


247
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 247

optional :read_only, DockerEngineRuby::Internal::Type::Boolean, api_name: :ReadOnly

#secrets ⇒ Array<DockerEngineRuby::Models::TaskSpec::ContainerSpec::Secret>?

Returns:



252
253
254
255
256
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 252

optional :secrets,
-> {
  DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::TaskSpec::ContainerSpec::Secret]
},
api_name: :Secrets

#stop_grace_period ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


261
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 261

optional :stop_grace_period, Integer, api_name: :StopGracePeriod

#stop_signal ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


266
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 266

optional :stop_signal, String, api_name: :StopSignal

#sysctls ⇒ Hash{Symbol=>String}?

Parameters:

  • (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}, nil) 


271
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 271

optional :sysctls, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Sysctls

#tty ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


276
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 276

optional :tty, DockerEngineRuby::Internal::Type::Boolean, api_name: :TTY

#ulimits ⇒ Array<DockerEngineRuby::Models::TaskSpec::ContainerSpec::Ulimit>?

Returns:



281
282
283
284
285
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 281

optional :ulimits,
-> {
  DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::TaskSpec::ContainerSpec::Ulimit]
},
api_name: :Ulimits

#user ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


290
 
# File 'lib/docker_engine_ruby/models/task_spec.rb', line 290

optional :user, String, api_name: :User

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/docker_engine_ruby/models/task_spec.rb', line 532

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


290
 
# File 'sig/docker_engine_ruby/models/task_spec.rbs', line 290

def to_hash: -> {