Class: DockerEngineAPI::Models::ImageListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/docker_engine_api/models/image_list_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(all: nil, digests: nil, filters: nil, manifests: nil, shared_size: nil, request_options: {}) ⇒ Object

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

Parameters:

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

    Show all images. Only images from a final layer (no children) are shown by defau

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

    Show digest information as a RepoDigests field on each image.

  • filters (String) (defaults to: nil) —

    A JSON encoded value of the filters (a map[string][]string) to

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

    Include Manifests in the image summary.

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

    Compute and show shared size as a SharedSize field on each image.

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



# File 'lib/docker_engine_api/models/image_list_params.rb', line 51

Instance Attribute Details

#all ⇒ Boolean?

Show all images. Only images from a final layer (no children) are shown by default.

Returns:

  • (Boolean, nil) 


15
 
# File 'lib/docker_engine_api/models/image_list_params.rb', line 15

optional :all, DockerEngineAPI::Internal::Type::Boolean

#digests ⇒ Boolean?

Show digest information as a RepoDigests field on each image.

Returns:

  • (Boolean, nil) 


21
 
# File 'lib/docker_engine_api/models/image_list_params.rb', line 21

optional :digests, DockerEngineAPI::Internal::Type::Boolean

#filters ⇒ String?

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

Available filters:

Returns:

  • (String, nil) 


37
 
# File 'lib/docker_engine_api/models/image_list_params.rb', line 37

optional :filters, String

#manifests ⇒ Boolean?

Include Manifests in the image summary.

Returns:

  • (Boolean, nil) 


43
 
# File 'lib/docker_engine_api/models/image_list_params.rb', line 43

optional :manifests, DockerEngineAPI::Internal::Type::Boolean

#shared_size ⇒ Boolean?

Compute and show shared size as a SharedSize field on each image.

Returns:

  • (Boolean, nil) 


49
 
# File 'lib/docker_engine_api/models/image_list_params.rb', line 49

optional :shared_size, DockerEngineAPI::Internal::Type::Boolean