Class: DockerEngineAPI::Models::ContainerWaitParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• DockerEngineAPI::Models::ContainerWaitParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/docker_engine_api/models/container_wait_params.rb

Overview

See Also:

• Resources::Containers#wait

Defined Under Namespace

Modules: Condition

Instance Attribute Summary

• #condition ⇒ Symbol, ...

  Wait until a container state reaches the given condition.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(condition: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ContainerWaitParams for more details.

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

Some parameter documentations has been truncated, see DockerEngineAPI::Models::ContainerWaitParams for more details.

Parameters:

• condition (Symbol, DockerEngineAPI::Models::ContainerWaitParams::Condition) (defaults to: nil) —

  Wait until a container state reaches the given condition.

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

# File 'lib/docker_engine_api/models/container_wait_params.rb', line 18

Instance Attribute Details

#condition ⇒ Symbol, ...

Wait until a container state reaches the given condition.

Defaults to not-running if omitted or empty.

Returns:

• (Symbol, DockerEngineAPI::Models::ContainerWaitParams::Condition, nil)

# File 'lib/docker_engine_api/models/container_wait_params.rb', line 16

optional :condition, enum: -> { DockerEngineAPI::ContainerWaitParams::Condition }