Class: DockerEngineRuby::Resources::Nodes

Inherits:
Object
  • Object
show all
Defined in:
lib/docker_engine_ruby/resources/nodes.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Nodes

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 Nodes.

Parameters:



98
99
100
 
# File 'lib/docker_engine_ruby/resources/nodes.rb', line 98

def initialize(client:)
  @client = client
end

Instance Method Details

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

Delete a node

Parameters:

Returns:

  • (nil)

See Also:



65
66
67
68
69
70
71
72
73
74
 
# File 'lib/docker_engine_ruby/resources/nodes.rb', line 65

def delete(id, params = {})
  parsed, options = DockerEngineRuby::NodeDeleteParams.dump_request(params)
  @client.request(
    method: :delete,
    path: ["nodes/%1$s", id],
    query: parsed,
    model: NilClass,
    options: options
  )
end

#inspect_(id, request_options: {}) ⇒ DockerEngineRuby::Models::Node

Inspect a node

Parameters:

Returns:

See Also:



86
87
88
89
90
91
92
93
 
# File 'lib/docker_engine_ruby/resources/nodes.rb', line 86

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

#list(filters: nil, request_options: {}) ⇒ Array<DockerEngineRuby::Models::Node>

List nodes

Parameters:

Returns:

See Also:



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

def list(params = {})
  parsed, options = DockerEngineRuby::NodeListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "nodes",
    query: parsed,
    model: DockerEngineRuby::Internal::Type::ArrayOf[DockerEngineRuby::Node],
    options: options
  )
end

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

Update a node

Parameters:

Returns:

  • (nil)

See Also:



21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/docker_engine_ruby/resources/nodes.rb', line 21

def update(id, params)
  parsed, options = DockerEngineRuby::NodeUpdateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["nodes/%1$s/update", id],
    query: parsed.except(:spec),
    body: parsed[:spec],
    model: NilClass,
    options: options
  )
end