class

Docr::Endpoints::Networks

The Networks class provides methods to interact with network-related endpoints. This class uses the client to send requests to the server and handles the responses.

Constructors

new(client : Docr::Client)

Initializes a new Networks instance with the provided client.

Source

Instance methods

client

A client instance used for making requests.

Source

connect

Connects a given container to a network. (Implementation is currently pending.)

Source

create(config : Docr::Types::NetworkConfig)

Creates a new network using the given configuration.

config: Configuration for creating the network.

Returns the created network.

Source

delete(id : String)

Deletes a specific network using its ID.

id: ID of the network to delete.

Deletes the network.

Source

disconnect

Disconnects a given container from a network. (Implementation is currently pending.)

Source

inspect(id : String, verbose : Bool = false, scope : String = "local") : Docr::Types::Network

Inspects a specific network using its ID. Additional optional parameters can be used to adjust the verbosity and scope of the inspection.

id: ID of the network to inspect.
verbose: If true, provides detailed information. Default is false.
scope: Specifies the scope of the inspection. Default is "local".

Returns details about the network.

Source

list

Retrieves a list of all networks.

Returns an array of network objects.

Source