Package io.github.alersrt.pod4j.openapi.api

Class NetworksCompatApi

java.lang.Object

io.github.alersrt.pod4j.openapi.api.NetworksCompatApi

public class NetworksCompatApi
extends Object

Constructor Summary

Constructors

Constructor	Description
NetworksCompatApi()
NetworksCompatApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
void	networkConnect(String name, ConnectOptions create)	Connect container to network Connect a container to a network
okhttp3.Call	networkConnectAsync(String name, ConnectOptions create, ApiCallback<Void> _callback)	Connect container to network (asynchronously) Connect a container to a network
okhttp3.Call	networkConnectCall(String name, ConnectOptions create, ApiCallback _callback)	Build call for networkConnect
ApiResponse<Void>	networkConnectWithHttpInfo(@NotNull String name, ConnectOptions create)	Connect container to network Connect a container to a network
NetworkCreate201Response	networkCreate(CreateRequest create)	Create network Create a network configuration
okhttp3.Call	networkCreateAsync(CreateRequest create, ApiCallback<NetworkCreate201Response> _callback)	Create network (asynchronously) Create a network configuration
okhttp3.Call	networkCreateCall(CreateRequest create, ApiCallback _callback)	Build call for networkCreate
ApiResponse<NetworkCreate201Response>	networkCreateWithHttpInfo(CreateRequest create)	Create network Create a network configuration
void	networkDelete(String name)	Remove a network Remove a network
okhttp3.Call	networkDeleteAsync(String name, ApiCallback<Void> _callback)	Remove a network (asynchronously) Remove a network
okhttp3.Call	networkDeleteCall(String name, ApiCallback _callback)	Build call for networkDelete
ApiResponse<Void>	networkDeleteWithHttpInfo(@NotNull String name)	Remove a network Remove a network
void	networkDisconnect(String name, DisconnectOptions create)	Disconnect container from network Disconnect a container from a network
okhttp3.Call	networkDisconnectAsync(String name, DisconnectOptions create, ApiCallback<Void> _callback)	Disconnect container from network (asynchronously) Disconnect a container from a network
okhttp3.Call	networkDisconnectCall(String name, DisconnectOptions create, ApiCallback _callback)	Build call for networkDisconnect
ApiResponse<Void>	networkDisconnectWithHttpInfo(@NotNull String name, DisconnectOptions create)	Disconnect container from network Disconnect a container from a network
Inspect	networkInspect(String name, Boolean verbose, String scope)	Inspect a network Display low level configuration network
okhttp3.Call	networkInspectAsync(String name, Boolean verbose, String scope, ApiCallback<Inspect> _callback)	Inspect a network (asynchronously) Display low level configuration network
okhttp3.Call	networkInspectCall(String name, Boolean verbose, String scope, ApiCallback _callback)	Build call for networkInspect
ApiResponse<Inspect>	networkInspectWithHttpInfo(@NotNull String name, Boolean verbose, String scope)	Inspect a network Display low level configuration network
List<Inspect>	networkList(String filters)	List networks Display summary of network configurations
okhttp3.Call	networkListAsync(String filters, ApiCallback<List<Inspect>> _callback)	List networks (asynchronously) Display summary of network configurations
okhttp3.Call	networkListCall(String filters, ApiCallback _callback)	Build call for networkList
ApiResponse<List<Inspect>>	networkListWithHttpInfo(String filters)	List networks Display summary of network configurations
NetworkPrune200Response	networkPrune(String filters)	Delete unused networks Remove networks that do not have containers
okhttp3.Call	networkPruneAsync(String filters, ApiCallback<NetworkPrune200Response> _callback)	Delete unused networks (asynchronously) Remove networks that do not have containers
okhttp3.Call	networkPruneCall(String filters, ApiCallback _callback)	Build call for networkPrune
ApiResponse<NetworkPrune200Response>	networkPruneWithHttpInfo(String filters)	Delete unused networks Remove networks that do not have containers
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NetworksCompatApi

public NetworksCompatApi()

NetworksCompatApi

public NetworksCompatApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

networkConnectCall

public okhttp3.Call networkConnectCall(String name,
 ConnectOptions create,
 ApiCallback _callback)
                                throws ApiException

Build call for networkConnect

Parameters:

name - the name of the network (required)

create - attributes for connecting a container to a network (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad parameter in request	-
403	Network is already connected and container is running or transitioning to the running state ('initialized')	-
500	Internal server error	-

networkConnect

public void networkConnect(String name,
 ConnectOptions create)
                    throws ApiException

Connect container to network Connect a container to a network

Parameters:

name - the name of the network (required)

create - attributes for connecting a container to a network (optional)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad parameter in request	-
403	Network is already connected and container is running or transitioning to the running state ('initialized')	-
500	Internal server error	-

networkConnectWithHttpInfo

public ApiResponse<Void> networkConnectWithHttpInfo(@NotNull
 @NotNull String name,
 ConnectOptions create)
                                             throws ApiException

Connect container to network Connect a container to a network

Parameters:

name - the name of the network (required)

create - attributes for connecting a container to a network (optional)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad parameter in request	-
403	Network is already connected and container is running or transitioning to the running state ('initialized')	-
500	Internal server error	-

networkConnectAsync

public okhttp3.Call networkConnectAsync(String name,
 ConnectOptions create,
 ApiCallback<Void> _callback)
                                 throws ApiException

Connect container to network (asynchronously) Connect a container to a network

Parameters:

name - the name of the network (required)

create - attributes for connecting a container to a network (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad parameter in request	-
403	Network is already connected and container is running or transitioning to the running state ('initialized')	-
500	Internal server error	-

networkCreateCall

public okhttp3.Call networkCreateCall(CreateRequest create,
 ApiCallback _callback)
                               throws ApiException

Build call for networkCreate

Parameters:

create - attributes for creating a network (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
201	network created	-
400	Bad parameter in request	-
500	Internal server error	-

networkCreate

public NetworkCreate201Response networkCreate(CreateRequest create)
                                       throws ApiException

Create network Create a network configuration

Parameters:

create - attributes for creating a network (optional)

Returns:

NetworkCreate201Response

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
201	network created	-
400	Bad parameter in request	-
500	Internal server error	-

networkCreateWithHttpInfo

public ApiResponse<NetworkCreate201Response> networkCreateWithHttpInfo(CreateRequest create)
                                                                throws ApiException

Create network Create a network configuration

Parameters:

create - attributes for creating a network (optional)

Returns:

ApiResponse<NetworkCreate201Response>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
201	network created	-
400	Bad parameter in request	-
500	Internal server error	-

networkCreateAsync

public okhttp3.Call networkCreateAsync(CreateRequest create,
 ApiCallback<NetworkCreate201Response> _callback)
                                throws ApiException

Create network (asynchronously) Create a network configuration

Parameters:

create - attributes for creating a network (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
201	network created	-
400	Bad parameter in request	-
500	Internal server error	-

networkDeleteCall

public okhttp3.Call networkDeleteCall(String name,
 ApiCallback _callback)
                               throws ApiException

Build call for networkDelete

Parameters:

name - the name of the network (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
204	no error	-
404	No such network	-
500	Internal server error	-

networkDelete

public void networkDelete(String name)
                   throws ApiException

Remove a network Remove a network

Parameters:

name - the name of the network (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
204	no error	-
404	No such network	-
500	Internal server error	-

networkDeleteWithHttpInfo

public ApiResponse<Void> networkDeleteWithHttpInfo(@NotNull
 @NotNull String name)
                                            throws ApiException

Remove a network Remove a network

Parameters:

name - the name of the network (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
204	no error	-
404	No such network	-
500	Internal server error	-

networkDeleteAsync

public okhttp3.Call networkDeleteAsync(String name,
 ApiCallback<Void> _callback)
                                throws ApiException

Remove a network (asynchronously) Remove a network

Parameters:

name - the name of the network (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
204	no error	-
404	No such network	-
500	Internal server error	-

networkDisconnectCall

public okhttp3.Call networkDisconnectCall(String name,
 DisconnectOptions create,
 ApiCallback _callback)
                                   throws ApiException

Build call for networkDisconnect

Parameters:

name - the name of the network (required)

create - attributes for disconnecting a container from a network (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad parameter in request	-
500	Internal server error	-

networkDisconnect

public void networkDisconnect(String name,
 DisconnectOptions create)
                       throws ApiException

Disconnect container from network Disconnect a container from a network

Parameters:

name - the name of the network (required)

create - attributes for disconnecting a container from a network (optional)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad parameter in request	-
500	Internal server error	-

networkDisconnectWithHttpInfo

public ApiResponse<Void> networkDisconnectWithHttpInfo(@NotNull
 @NotNull String name,
 DisconnectOptions create)
                                                throws ApiException

Disconnect container from network Disconnect a container from a network

Parameters:

name - the name of the network (required)

create - attributes for disconnecting a container from a network (optional)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad parameter in request	-
500	Internal server error	-

networkDisconnectAsync

public okhttp3.Call networkDisconnectAsync(String name,
 DisconnectOptions create,
 ApiCallback<Void> _callback)
                                    throws ApiException

Disconnect container from network (asynchronously) Disconnect a container from a network

Parameters:

name - the name of the network (required)

create - attributes for disconnecting a container from a network (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200	OK	-
400	Bad parameter in request	-
500	Internal server error	-

networkInspectCall

public okhttp3.Call networkInspectCall(String name,
 Boolean verbose,
 String scope,
 ApiCallback _callback)
                                throws ApiException

Build call for networkInspect

Parameters:

name - the name of the network (required)

verbose - Detailed inspect output for troubleshooting (optional)

scope - Filter the network by scope (swarm, global, or local) (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	Network inspect	-
404	No such network	-
500	Internal server error	-

networkInspect

public Inspect networkInspect(String name,
 Boolean verbose,
 String scope)
                       throws ApiException

Inspect a network Display low level configuration network

Parameters:

name - the name of the network (required)

verbose - Detailed inspect output for troubleshooting (optional)

scope - Filter the network by scope (swarm, global, or local) (optional)

Returns:

Inspect

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	Network inspect	-
404	No such network	-
500	Internal server error	-

networkInspectWithHttpInfo

public ApiResponse<Inspect> networkInspectWithHttpInfo(@NotNull
 @NotNull String name,
 Boolean verbose,
 String scope)
                                                throws ApiException

Inspect a network Display low level configuration network

Parameters:

name - the name of the network (required)

verbose - Detailed inspect output for troubleshooting (optional)

scope - Filter the network by scope (swarm, global, or local) (optional)

Returns:

ApiResponse<Inspect>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	Network inspect	-
404	No such network	-
500	Internal server error	-

networkInspectAsync

public okhttp3.Call networkInspectAsync(String name,
 Boolean verbose,
 String scope,
 ApiCallback<Inspect> _callback)
                                 throws ApiException

Inspect a network (asynchronously) Display low level configuration network

Parameters:

name - the name of the network (required)

verbose - Detailed inspect output for troubleshooting (optional)

scope - Filter the network by scope (swarm, global, or local) (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200	Network inspect	-
404	No such network	-
500	Internal server error	-

networkListCall

public okhttp3.Call networkListCall(String filters,
 ApiCallback _callback)
                             throws ApiException

Build call for networkList

Parameters:

filters - JSON encoded value of the filters (a `map[string][]string`) to process on the network list. Currently available filters: - `name=[name]` Matches network name (accepts regex). - `id=[id]` Matches for full or partial ID. - `driver=[driver]` Only bridge is supported. - `label=[key]` or `label=[key=value]` Matches networks based on the presence of a label alone or a label and a value. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	Network list	-
500	Internal server error	-

networkList

public List<Inspect> networkList(String filters)
                          throws ApiException

List networks Display summary of network configurations

Parameters:

filters - JSON encoded value of the filters (a `map[string][]string`) to process on the network list. Currently available filters: - `name=[name]` Matches network name (accepts regex). - `id=[id]` Matches for full or partial ID. - `driver=[driver]` Only bridge is supported. - `label=[key]` or `label=[key=value]` Matches networks based on the presence of a label alone or a label and a value. (optional)

Returns:

List<Inspect>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	Network list	-
500	Internal server error	-

networkListWithHttpInfo

public ApiResponse<List<Inspect>> networkListWithHttpInfo(String filters)
                                                   throws ApiException

List networks Display summary of network configurations

Parameters:

filters - JSON encoded value of the filters (a `map[string][]string`) to process on the network list. Currently available filters: - `name=[name]` Matches network name (accepts regex). - `id=[id]` Matches for full or partial ID. - `driver=[driver]` Only bridge is supported. - `label=[key]` or `label=[key=value]` Matches networks based on the presence of a label alone or a label and a value. (optional)

Returns:

ApiResponse<List<Inspect>>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	Network list	-
500	Internal server error	-

networkListAsync

public okhttp3.Call networkListAsync(String filters,
 ApiCallback<List<Inspect>> _callback)
                              throws ApiException

List networks (asynchronously) Display summary of network configurations

Parameters:

filters - JSON encoded value of the filters (a `map[string][]string`) to process on the network list. Currently available filters: - `name=[name]` Matches network name (accepts regex). - `id=[id]` Matches for full or partial ID. - `driver=[driver]` Only bridge is supported. - `label=[key]` or `label=[key=value]` Matches networks based on the presence of a label alone or a label and a value. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200	Network list	-
500	Internal server error	-

networkPruneCall

public okhttp3.Call networkPruneCall(String filters,
 ApiCallback _callback)
                              throws ApiException

Build call for networkPrune

Parameters:

filters - Filters to process on the prune list, encoded as JSON (a map[string][]string). Available filters: - `until=<timestamp>` Prune networks created before this timestamp. The <timestamp> can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune networks with (or without, in case `label!=...` is used) the specified labels. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200	OK	-
500	Internal server error	-

networkPrune

public NetworkPrune200Response networkPrune(String filters)
                                     throws ApiException

Delete unused networks Remove networks that do not have containers

Parameters:

filters - Filters to process on the prune list, encoded as JSON (a map[string][]string). Available filters: - `until=<timestamp>` Prune networks created before this timestamp. The <timestamp> can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune networks with (or without, in case `label!=...` is used) the specified labels. (optional)

Returns:

NetworkPrune200Response

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	OK	-
500	Internal server error	-

networkPruneWithHttpInfo

public ApiResponse<NetworkPrune200Response> networkPruneWithHttpInfo(String filters)
                                                              throws ApiException

Delete unused networks Remove networks that do not have containers

Parameters:

filters - Filters to process on the prune list, encoded as JSON (a map[string][]string). Available filters: - `until=<timestamp>` Prune networks created before this timestamp. The <timestamp> can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune networks with (or without, in case `label!=...` is used) the specified labels. (optional)

Returns:

ApiResponse<NetworkPrune200Response>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200	OK	-
500	Internal server error	-

networkPruneAsync

public okhttp3.Call networkPruneAsync(String filters,
 ApiCallback<NetworkPrune200Response> _callback)
                               throws ApiException

Delete unused networks (asynchronously) Remove networks that do not have containers

Parameters:

filters - Filters to process on the prune list, encoded as JSON (a map[string][]string). Available filters: - `until=<timestamp>` Prune networks created before this timestamp. The <timestamp> can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. `10m`, `1h30m`) computed relative to the daemon machine’s time. - `label` (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) Prune networks with (or without, in case `label!=...` is used) the specified labels. (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200	OK	-
500	Internal server error	-