Class: DockerEngineAPI::Models::ImageCommitParams

Inherits:
Config show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/docker_engine_api/models/image_commit_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Attributes inherited from Config

#args_escaped, #attach_stderr, #attach_stdin, #attach_stdout, #cmd, #domainname, #entrypoint, #env, #exposed_ports, #healthcheck, #hostname, #image, #labels, #network_disabled, #on_build, #open_stdin, #shell, #stdin_once, #stop_signal, #stop_timeout, #tty, #user, #volumes, #working_dir

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(author: nil, changes: nil, comment: nil, container: nil, pause: nil, repo: nil, tag: nil, request_options: {}) ⇒ Object

Parameters:

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

    Author of the image (e.g., ‘John Hannibal Smith <[email protected]>`)

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

    Dockerfile instructions to apply while committing

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

    Commit message

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

    The ID or name of the container to commit

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

    Whether to pause the container before committing

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

    Repository name for the created image

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

    Tag name for the create image

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



# File 'lib/docker_engine_api/models/image_commit_params.rb', line 52

Instance Attribute Details

#author ⇒ String?

Author of the image (e.g., ‘John Hannibal Smith <[email protected]>`)

Returns:

  • (String, nil) 


14
 
# File 'lib/docker_engine_api/models/image_commit_params.rb', line 14

optional :author, String

#changes ⇒ String?

Dockerfile instructions to apply while committing

Returns:

  • (String, nil) 


20
 
# File 'lib/docker_engine_api/models/image_commit_params.rb', line 20

optional :changes, String

#comment ⇒ String?

Commit message

Returns:

  • (String, nil) 


26
 
# File 'lib/docker_engine_api/models/image_commit_params.rb', line 26

optional :comment, String

#container ⇒ String?

The ID or name of the container to commit

Returns:

  • (String, nil) 


32
 
# File 'lib/docker_engine_api/models/image_commit_params.rb', line 32

optional :container, String

#pause ⇒ Boolean?

Whether to pause the container before committing

Returns:

  • (Boolean, nil) 


38
 
# File 'lib/docker_engine_api/models/image_commit_params.rb', line 38

optional :pause, DockerEngineAPI::Internal::Type::Boolean

#repo ⇒ String?

Repository name for the created image

Returns:

  • (String, nil) 


44
 
# File 'lib/docker_engine_api/models/image_commit_params.rb', line 44

optional :repo, String

#tag ⇒ String?

Tag name for the create image

Returns:

  • (String, nil) 


50
 
# File 'lib/docker_engine_api/models/image_commit_params.rb', line 50

optional :tag, String