Class: DockerEngineRuby::Resources::Volumes

Inherits:
Object
  • Object
show all
Defined in:
lib/docker_engine_ruby/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:



146
147
148
 
# File 'lib/docker_engine_ruby/resources/volumes.rb', line 146

def initialize(client:)
  @client = client
end

Instance Method Details

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

Create a volume

Parameters:

Returns:

See Also:



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

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

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

Remove a volume

Parameters:

Returns:

  • (nil)

See Also:



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/docker_engine_ruby/resources/volumes.rb', line 90

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

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

Inspect a volume

Parameters:

Returns:

See Also:



112
113
114
115
116
117
118
119
 
# File 'lib/docker_engine_ruby/resources/volumes.rb', line 112

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

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

List volumes

Parameters:

Returns:

See Also:



67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/docker_engine_ruby/resources/volumes.rb', line 67

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

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

Delete unused volumes

Parameters:

Returns:

See Also:



131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/docker_engine_ruby/resources/volumes.rb', line 131

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

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

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

Parameters:

Returns:

  • (nil)

See Also:



43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/docker_engine_ruby/resources/volumes.rb', line 43

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