Class: DockerEngineRuby::Resources::Networks

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Networks

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

Parameters:



194
195
196
 
# File 'lib/docker_engine_ruby/resources/networks.rb', line 194

def initialize(client:)
  @client = client
end

Instance Method Details

#connect(id, container:, endpoint_config: nil, request_options: {}) ⇒ nil

Connect a container to a network

Parameters:

Returns:

  • (nil)

See Also:



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

def connect(id, params)
  parsed, options = DockerEngineRuby::NetworkConnectParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["networks/%1$s/connect", id],
    body: parsed,
    model: NilClass,
    options: options
  )
end

#create(name:, attachable: nil, config_from: nil, config_only: nil, driver: nil, enable_i_pv4: nil, enable_i_pv6: nil, ingress: nil, internal: nil, ipam: nil, labels: nil, options: nil, scope: nil, request_options: {}) ⇒ DockerEngineRuby::Models::NetworkCreateResponse

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

Create a network

Parameters:

Returns:

See Also:



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

def create(params)
  parsed, options = DockerEngineRuby::NetworkCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "networks/create",
    body: parsed,
    model: DockerEngineRuby::NetworkCreateResponse,
    options: options
  )
end

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

Remove a network

Parameters:

Returns:

  • (nil)

See Also:



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

def delete(id, params = {})
  @client.request(
    method: :delete,
    path: ["networks/%1$s", id],
    model: NilClass,
    options: params[:request_options]
  )
end

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

Disconnect a container from a network

Parameters:

  • id (String)
  • container (String) —

    The ID or name of the container to disconnect from the network.

  • force (Boolean) —

    Force the container to disconnect from the network.

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

Returns:

  • (nil)

See Also:



136
137
138
139
140
141
142
143
144
145
 
# File 'lib/docker_engine_ruby/resources/networks.rb', line 136

def disconnect(id, params)
  parsed, options = DockerEngineRuby::NetworkDisconnectParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["networks/%1$s/disconnect", id],
    body: parsed,
    model: NilClass,
    options: options
  )
end

#inspect_(id, scope: nil, verbose: nil, request_options: {}) ⇒ DockerEngineRuby::Models::NetworkInspectResponse

Inspect a network

Parameters:

Returns:

See Also:



159
160
161
162
163
164
165
166
167
168
 
# File 'lib/docker_engine_ruby/resources/networks.rb', line 159

def inspect_(id, params = {})
  parsed, options = DockerEngineRuby::NetworkInspectParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["networks/%1$s", id],
    query: parsed,
    model: DockerEngineRuby::Models::NetworkInspectResponse,
    options: options
  )
end

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

List networks

Parameters:

Returns:

See Also:



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

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

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

Delete unused networks

Parameters:

Returns:

See Also:



180
181
182
183
184
185
186
187
188
189
 
# File 'lib/docker_engine_ruby/resources/networks.rb', line 180

def prune(params = {})
  parsed, options = DockerEngineRuby::NetworkPruneParams.dump_request(params)
  @client.request(
    method: :post,
    path: "networks/prune",
    query: parsed,
    model: DockerEngineRuby::Models::NetworkPruneResponse,
    options: options
  )
end