Class: DockerEngineRuby::Models::ContainerExecParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/docker_engine_ruby/models/container_exec_params.rb,
sig/docker_engine_ruby/models/container_exec_params.rbs

Overview

See Also:

  • DockerEngineRuby::Resources::Containers#exec_

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::DockerEngineRuby

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(id:, attach_stderr: nil, attach_stdin: nil, attach_stdout: nil, cmd: nil, console_size: nil, detach_keys: nil, env: nil, privileged: nil, tty: nil, user: nil, working_dir: nil, request_options: {}) ⇒ Object

Parameters:

  • id (String)
  • attach_stderr (Boolean) (defaults to: nil)
  • attach_stdin (Boolean) (defaults to: nil)
  • attach_stdout (Boolean) (defaults to: nil)
  • cmd (Array<String>) (defaults to: nil)
  • console_size (Array<Integer>, nil) (defaults to: nil)
  • detach_keys (String) (defaults to: nil)
  • env (Array<String>) (defaults to: nil)
  • privileged (Boolean) (defaults to: nil)
  • tty (Boolean) (defaults to: nil)
  • user (String) (defaults to: nil)
  • working_dir (String) (defaults to: nil)
  • request_options (DockerEngineRuby::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/docker_engine_ruby/models/container_exec_params.rb', line 73

Instance Attribute Details

#attach_stderr ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


18
 
# File 'lib/docker_engine_ruby/models/container_exec_params.rb', line 18

optional :attach_stderr, DockerEngineRuby::Internal::Type::Boolean, api_name: :AttachStderr

#attach_stdin ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


23
 
# File 'lib/docker_engine_ruby/models/container_exec_params.rb', line 23

optional :attach_stdin, DockerEngineRuby::Internal::Type::Boolean, api_name: :AttachStdin

#attach_stdout ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


28
 
# File 'lib/docker_engine_ruby/models/container_exec_params.rb', line 28

optional :attach_stdout, DockerEngineRuby::Internal::Type::Boolean, api_name: :AttachStdout

#cmd ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


33
 
# File 'lib/docker_engine_ruby/models/container_exec_params.rb', line 33

optional :cmd, DockerEngineRuby::Internal::Type::ArrayOf[String], api_name: :Cmd

#console_size ⇒ Array<Integer>?

Parameters:

  • value (::Array[Integer], nil)

Returns:

  • (Array<Integer>, nil) 


38
39
40
41
 
# File 'lib/docker_engine_ruby/models/container_exec_params.rb', line 38

optional :console_size,
DockerEngineRuby::Internal::Type::ArrayOf[Integer],
api_name: :ConsoleSize,
nil?: true

#detach_keys ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


46
 
# File 'lib/docker_engine_ruby/models/container_exec_params.rb', line 46

optional :detach_keys, String, api_name: :DetachKeys

#env ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


51
 
# File 'lib/docker_engine_ruby/models/container_exec_params.rb', line 51

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

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/docker_engine_ruby/models/container_exec_params.rb', line 13

required :id, String

#privileged ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


56
 
# File 'lib/docker_engine_ruby/models/container_exec_params.rb', line 56

optional :privileged, DockerEngineRuby::Internal::Type::Boolean, api_name: :Privileged

#tty ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


61
 
# File 'lib/docker_engine_ruby/models/container_exec_params.rb', line 61

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

#user ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


66
 
# File 'lib/docker_engine_ruby/models/container_exec_params.rb', line 66

optional :user, String, api_name: :User

#working_dir ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


71
 
# File 'lib/docker_engine_ruby/models/container_exec_params.rb', line 71

optional :working_dir, String, api_name: :WorkingDir

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


84
 
# File 'sig/docker_engine_ruby/models/container_exec_params.rbs', line 84

def to_hash: -> {