Class: DockerEngineAPI::Resources::Volumes

Inherits:
Object
  • Object
show all
Defined in:
lib/docker_engine_api/resources/volumes.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Volumes

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Volumes.

Parameters:



156
157
158
 
# File 'lib/docker_engine_api/resources/volumes.rb', line 156

def initialize(client:)
  @client = client
end

Instance Method Details

#create(create_request:, request_options: {}) ⇒ DockerEngineAPI::Models::Volume

Create a volume

Parameters:

Returns:

See Also:



17
18
19
20
21
22
23
24
25
26
 
# File 'lib/docker_engine_api/resources/volumes.rb', line 17

def create(params)
  parsed, options = DockerEngineAPI::VolumeCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "volumes/create",
    body: parsed[:create_request],
    model: DockerEngineAPI::Volume,
    options: options
  )
end

#delete(name, force: nil, request_options: {}) ⇒ nil

Instruct the driver to remove the volume.

Parameters:

  • name (String) —

    Volume name or ID

  • force (Boolean) —

    Force the removal of the volume

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

Returns:

  • (nil)

See Also:



97
98
99
100
101
102
103
104
105
106
 
# File 'lib/docker_engine_api/resources/volumes.rb', line 97

def delete(name, params = {})
  parsed, options = DockerEngineAPI::VolumeDeleteParams.dump_request(params)
  @client.request(
    method: :delete,
    path: ["volumes/%1$s", name],
    query: parsed,
    model: NilClass,
    options: options
  )
end

#inspect_(name, request_options: {}) ⇒ DockerEngineAPI::Models::Volume

Inspect a volume

Parameters:

Returns:

See Also:



119
120
121
122
123
124
125
126
 
# File 'lib/docker_engine_api/resources/volumes.rb', line 119

def inspect_(name, params = {})
  @client.request(
    method: :get,
    path: ["volumes/%1$s", name],
    model: DockerEngineAPI::Volume,
    options: params[:request_options]
  )
end

#list(filters: nil, request_options: {}) ⇒ DockerEngineAPI::Models::ListResponse

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

List volumes

Parameters:

  • filters (String) —

    JSON encoded value of the filters (a map[string][]string) to

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

Returns:

See Also:



73
74
75
76
77
78
79
80
81
82
 
# File 'lib/docker_engine_api/resources/volumes.rb', line 73

def list(params = {})
  parsed, options = DockerEngineAPI::VolumeListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "volumes",
    query: parsed,
    model: DockerEngineAPI::ListResponse,
    options: options
  )
end

#prune(filters: nil, request_options: {}) ⇒ DockerEngineAPI::Models::VolumePruneResponse

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

Delete unused volumes

Parameters:

  • filters (String) —

    Filters to process on the prune list, encoded as JSON (a map[string][]string).

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

Returns:

See Also:



142
143
144
145
146
147
148
149
150
151
 
# File 'lib/docker_engine_api/resources/volumes.rb', line 142

def prune(params = {})
  parsed, options = DockerEngineAPI::VolumePruneParams.dump_request(params)
  @client.request(
    method: :post,
    path: "volumes/prune",
    query: parsed,
    model: DockerEngineAPI::Models::VolumePruneResponse,
    options: options
  )
end

#update(name, version:, spec: nil, request_options: {}) ⇒ nil

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

“Update a volume. Valid only for Swarm cluster volumes”

Parameters:

Returns:

  • (nil)

See Also:



46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/docker_engine_api/resources/volumes.rb', line 46

def update(name, params)
  parsed, options = DockerEngineAPI::VolumeUpdateParams.dump_request(params)
  query_params = [:version]
  @client.request(
    method: :put,
    path: ["volumes/%1$s", name],
    query: parsed.slice(*query_params),
    body: parsed.except(*query_params),
    model: NilClass,
    options: options
  )
end