Class: DockerEngineAPI::Models::ServiceListParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/docker_engine_api/models/service_list_params.rb

Overview

See Also:

• Resources::Services#list

Instance Attribute Summary

• #filters ⇒ String^?

  A JSON encoded value of the filters (a map[string][]string) to process on the services list.

• #status ⇒ Boolean^?

  Include service status, with count of running and desired tasks.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

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

  Some parameter documentations has been truncated, see ServiceListParams 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(filters: nil, status: nil, request_options: {}) ⇒ Object

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

# File 'lib/docker_engine_api/models/service_list_params.rb', line 30

Instance Attribute Details

#filters ⇒ String^?

A JSON encoded value of the filters (a map[string][]string) to process on the services list.

Available filters:

• ‘id=<service id>`

• ‘label=<service label>`

• ‘mode=`

• ‘name=<service name>`

# File 'lib/docker_engine_api/models/service_list_params.rb', line 22

optional :filters, String

#status ⇒ Boolean^?

Include service status, with count of running and desired tasks.

# File 'lib/docker_engine_api/models/service_list_params.rb', line 28

optional :status, DockerEngineAPI::Internal::Type::Boolean