Class: DockerEngineRuby::Models::CreateRequest

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/docker_engine_ruby/models/create_request.rb

Defined Under Namespace

Classes: ClusterVolumeSpec

Instance Attribute Summary collapse

Instance Method Summary collapse

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(cluster_volume_spec: nil, driver: nil, driver_opts: nil, labels: nil, name: nil) ⇒ Object

Some parameter documentations has been truncated, see DockerEngineRuby::Models::CreateRequest for more details.

Volume configuration

Parameters:

  • cluster_volume_spec (DockerEngineRuby::Models::CreateRequest::ClusterVolumeSpec) (defaults to: nil) —

    Cluster-specific options used to create the volume.

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

    Name of the volume driver to use.

  • driver_opts (Hash{Symbol=>String}) (defaults to: nil) —

    A mapping of driver options and values. These options are

  • labels (Hash{Symbol=>String}) (defaults to: nil) —

    User-defined key/value metadata.

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

    The new volume’s name. If not specified, Docker generates a name.




# File 'lib/docker_engine_ruby/models/create_request.rb', line 39

Instance Attribute Details

#cluster_volume_spec ⇒ DockerEngineRuby::Models::CreateRequest::ClusterVolumeSpec?

Cluster-specific options used to create the volume.

Returns:



10
11
12
 
# File 'lib/docker_engine_ruby/models/create_request.rb', line 10

optional :cluster_volume_spec,
-> { DockerEngineRuby::CreateRequest::ClusterVolumeSpec },
api_name: :ClusterVolumeSpec

#driver ⇒ String?

Name of the volume driver to use.

Returns:

  • (String, nil) 


18
 
# File 'lib/docker_engine_ruby/models/create_request.rb', line 18

optional :driver, String, api_name: :Driver

#driver_opts ⇒ Hash{Symbol=>String}?

A mapping of driver options and values. These options are passed directly to the driver and are driver specific.

Returns:

  • (Hash{Symbol=>String}, nil) 


25
 
# File 'lib/docker_engine_ruby/models/create_request.rb', line 25

optional :driver_opts, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :DriverOpts

#labels ⇒ Hash{Symbol=>String}?

User-defined key/value metadata.

Returns:

  • (Hash{Symbol=>String}, nil) 


31
 
# File 'lib/docker_engine_ruby/models/create_request.rb', line 31

optional :labels, DockerEngineRuby::Internal::Type::HashOf[String], api_name: :Labels

#name ⇒ String?

The new volume’s name. If not specified, Docker generates a name.

Returns:

  • (String, nil) 


37
 
# File 'lib/docker_engine_ruby/models/create_request.rb', line 37

optional :name, String, api_name: :Name