Class NetworksCompatApi

java.lang.Object
io.github.alersrt.pod4j.openapi.api.NetworksCompatApi

public class NetworksCompatApi extends Object
  • 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)
    • networkConnect

      public NetworksCompatApi.APInetworkConnectRequest networkConnect(String name)
      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

      public NetworksCompatApi.APInetworkDisconnectRequest networkDisconnect(String name)
      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

      public NetworksCompatApi.APInetworkInspectRequest networkInspect(String name)
      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 -