Class: DockerEngine::Models::ExecStartParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/docker_engine/models/exec_start_params.rb

Overview

See Also:

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(console_size: nil, detach: nil, tty: nil, request_options: {}) ⇒ Object

Parameters:

  • console_size (Array<Integer>, nil) (defaults to: nil) —

    Initial console size, as an [height, width] array.

  • detach (Boolean) (defaults to: nil) —

    Detach from the command.

  • tty (Boolean) (defaults to: nil) —

    Allocate a pseudo-TTY.

  • request_options (DockerEngine::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/docker_engine/models/exec_start_params.rb', line 31

Instance Attribute Details

#console_size ⇒ Array<Integer>?

Initial console size, as an [height, width] array.

Returns:

  • (Array<Integer>, nil) 


14
15
16
17
 
# File 'lib/docker_engine/models/exec_start_params.rb', line 14

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

#detach ⇒ Boolean?

Detach from the command.

Returns:

  • (Boolean, nil) 


23
 
# File 'lib/docker_engine/models/exec_start_params.rb', line 23

optional :detach, DockerEngine::Internal::Type::Boolean, api_name: :Detach

#tty ⇒ Boolean?

Allocate a pseudo-TTY.

Returns:

  • (Boolean, nil) 


29
 
# File 'lib/docker_engine/models/exec_start_params.rb', line 29

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