Class: DockerEngine::Models::Container::HostConfig::Mount::VolumeOptions

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/docker_engine/models/container.rb

Overview

See Also:

Defined Under Namespace

Classes: DriverConfig

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(driver_config: nil, labels: nil, no_copy: nil, subpath: nil) ⇒ Object

Optional configuration for the volume type.

Parameters:

  • driver_config (DockerEngine::Models::Container::HostConfig::Mount::VolumeOptions::DriverConfig) (defaults to: nil) —

    Map of driver specific options

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

    User-defined key/value metadata.

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

    Populate volume with data from the target.

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

    Source path inside the volume. Must be relative without any back traversals.




# File 'lib/docker_engine/models/container.rb', line 1561

Instance Attribute Details

#driver_config ⇒ DockerEngine::Models::Container::HostConfig::Mount::VolumeOptions::DriverConfig?

Map of driver specific options

Returns:



1539
1540
1541
 
# File 'lib/docker_engine/models/container.rb', line 1539

optional :driver_config,
-> { DockerEngine::Container::HostConfig::Mount::VolumeOptions::DriverConfig },
api_name: :DriverConfig

#labels ⇒ Hash{Symbol=>String}?

User-defined key/value metadata.

Returns:

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


1547
 
# File 'lib/docker_engine/models/container.rb', line 1547

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

#no_copy ⇒ Boolean?

Populate volume with data from the target.

Returns:

  • (Boolean, nil) 


1553
 
# File 'lib/docker_engine/models/container.rb', line 1553

optional :no_copy, DockerEngine::Internal::Type::Boolean, api_name: :NoCopy

#subpath ⇒ String?

Source path inside the volume. Must be relative without any back traversals.

Returns:

  • (String, nil) 


1559
 
# File 'lib/docker_engine/models/container.rb', line 1559

optional :subpath, String, api_name: :Subpath