Class NetworksCompatApi
java.lang.Object
io.github.alersrt.pod4j.openapi.api.NetworksCompatApi
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionclassclassclassclassclassclassclass -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintnetworkConnect(String name) Connect container to network Connect a container to a networkCreate network Create a network configurationnetworkDelete(String name) Remove a network Remove a networknetworkDisconnect(String name) Disconnect container from network Disconnect a container from a networknetworkInspect(String name) Inspect a network Display low level configuration networkList networks Display summary of network configurationsDelete unused networks Remove networks that do not have containersvoidsetApiClient(ApiClient apiClient) voidsetCustomBaseUrl(String customBaseUrl) voidsetHostIndex(int hostIndex)
-
Constructor Details
-
NetworksCompatApi
public NetworksCompatApi() -
NetworksCompatApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
getHostIndex
public int getHostIndex() -
setHostIndex
public void setHostIndex(int hostIndex) -
getCustomBaseUrl
-
setCustomBaseUrl
-
networkConnect
Connect container to network Connect a container to a network- Parameters:
name- the name of the network (required)- Returns:
- APInetworkConnectRequest
- 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 -
-
networkCreate
Create network Create a network configuration- Returns:
- APInetworkCreateRequest
- Http Response Details
Status Code Description Response Headers 201 network created - 400 Bad parameter in request - 500 Internal server error -
-
networkDelete
Remove a network Remove a network- Parameters:
name- the name of the network (required)- Returns:
- APInetworkDeleteRequest
- Http Response Details
Status Code Description Response Headers 204 no error - 404 No such network - 500 Internal server error -
-
networkDisconnect
Disconnect container from network Disconnect a container from a network- Parameters:
name- the name of the network (required)- Returns:
- APInetworkDisconnectRequest
- Http Response Details
Status Code Description Response Headers 200 OK - 400 Bad parameter in request - 500 Internal server error -
-
networkInspect
Inspect a network Display low level configuration network- Parameters:
name- the name of the network (required)- Returns:
- APInetworkInspectRequest
- Http Response Details
Status Code Description Response Headers 200 Network inspect - 404 No such network - 500 Internal server error -
-
networkList
List networks Display summary of network configurations- Returns:
- APInetworkListRequest
- Http Response Details
Status Code Description Response Headers 200 Network list - 500 Internal server error -
-
networkPrune
Delete unused networks Remove networks that do not have containers- Returns:
- APInetworkPruneRequest
- Http Response Details
Status Code Description Response Headers 200 OK - 500 Internal server error -
-