Class: DockerEngineAPI::Models::ContainerCreateParams::Config::HostConfig::Mount::VolumeOptions

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• DockerEngineAPI::Models::ContainerCreateParams::Config::HostConfig::Mount::VolumeOptions

Defined in:

lib/docker_engine_api/models/container_create_params.rb

Overview

See Also:

• #volume_options

Defined Under Namespace

Classes: DriverConfig

Instance Attribute Summary

• #driver_config ⇒ DockerEngineAPI::Models::ContainerCreateParams::Config::HostConfig::Mount::VolumeOptions::DriverConfig^?

  Map of driver specific options.

• #labels ⇒ Hash{Symbol=>String}^?

  User-defined key/value metadata.

• #no_copy ⇒ Boolean^?

  Populate volume with data from the target.

• #subpath ⇒ String^?

  Source path inside the volume.

Instance Method Summary

• #initialize(driver_config: nil, labels: nil, no_copy: nil, subpath: nil) ⇒ Object constructor

  Optional configuration for the volume type.

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 (DockerEngineAPI::Models::ContainerCreateParams::Config::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_api/models/container_create_params.rb', line 1377

Instance Attribute Details

#driver_config ⇒ DockerEngineAPI::Models::ContainerCreateParams::Config::HostConfig::Mount::VolumeOptions::DriverConfig^?

Map of driver specific options

Returns:

• (DockerEngineAPI::Models::ContainerCreateParams::Config::HostConfig::Mount::VolumeOptions::DriverConfig, nil)

# File 'lib/docker_engine_api/models/container_create_params.rb', line 1353

optional :driver_config,
-> {
  DockerEngineAPI::ContainerCreateParams::Config::HostConfig::Mount::VolumeOptions::DriverConfig
},
api_name: :DriverConfig

#labels ⇒ Hash{Symbol=>String}^?

User-defined key/value metadata.

Returns:

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

# File 'lib/docker_engine_api/models/container_create_params.rb', line 1363

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

#no_copy ⇒ Boolean^?

Populate volume with data from the target.

Returns:

• (Boolean, nil)

# File 'lib/docker_engine_api/models/container_create_params.rb', line 1369

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

#subpath ⇒ String^?

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

Returns:

• (String, nil)

# File 'lib/docker_engine_api/models/container_create_params.rb', line 1375

optional :subpath, String, api_name: :Subpath