Class: DockerEngineAPI::Models::ImageLoadParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/docker_engine_api/models/image_load_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(body:, platform: nil, quiet: nil, request_options: {}) ⇒ Object

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

Parameters:

  • body (Pathname, StringIO, IO, String, DockerEngineAPI::FilePart)
  • platform (Array<String>) (defaults to: nil) —

    JSON encoded OCI platform(s) which will be used to select the

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

    Suppress progress details during load.

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



# File 'lib/docker_engine_api/models/image_load_params.rb', line 31

Instance Attribute Details

#body ⇒ Pathname, ...

Returns:



13
 
# File 'lib/docker_engine_api/models/image_load_params.rb', line 13

required :body, DockerEngineAPI::Internal::Type::FileInput

#platform ⇒ Array<String>?

JSON encoded OCI platform(s) which will be used to select the platform-specific image(s) to load if the image is multi-platform. If not provided, the full multi-platform image will be loaded.

Example: ‘“linux”, “architecture”: “arm”, “variant”: “v5”`

Returns:

  • (Array<String>, nil) 


23
 
# File 'lib/docker_engine_api/models/image_load_params.rb', line 23

optional :platform, DockerEngineAPI::Internal::Type::ArrayOf[String]

#quiet ⇒ Boolean?

Suppress progress details during load.

Returns:

  • (Boolean, nil) 


29
 
# File 'lib/docker_engine_api/models/image_load_params.rb', line 29

optional :quiet, DockerEngineAPI::Internal::Type::Boolean