Class: DockerEngineAPI::Resources::Nodes

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



108
109
110
 
# File 'lib/docker_engine_api/resources/nodes.rb', line 108

def initialize(client:)
  @client = client
end

Instance Method Details

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

Delete a node

Parameters:

  • id (String) —

    The ID or name of the node

  • force (Boolean) —

    Force remove a node from the swarm

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

Returns:

  • (nil)

See Also:



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

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

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

Inspect a node

Parameters:

Returns:

See Also:



96
97
98
99
100
101
102
103
 
# File 'lib/docker_engine_api/resources/nodes.rb', line 96

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

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

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

List nodes

Parameters:

  • filters (String) —

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

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

Returns:

See Also:



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/docker_engine_api/resources/nodes.rb', line 50

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

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

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

Update a node

Parameters:

Returns:

  • (nil)

See Also:



24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/docker_engine_api/resources/nodes.rb', line 24

def update(id, params)
  parsed, options = DockerEngineAPI::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