Class NetworksApi

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

public class NetworksApi extends Object
  • Constructor Details

    • NetworksApi

      public NetworksApi()
    • NetworksApi

      public NetworksApi(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)
    • networkConnectLibpodCall

      public okhttp3.Call networkConnectLibpodCall(String name, NetworkConnectOptions create, ApiCallback _callback) throws ApiException
      Build call for networkConnectLibpod
      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 -
      404 No such network -
      500 Internal server error -
    • networkConnectLibpod

      public void networkConnectLibpod(String name, NetworkConnectOptions 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 -
      404 No such network -
      500 Internal server error -
    • networkConnectLibpodWithHttpInfo

      public ApiResponse<Void> networkConnectLibpodWithHttpInfo(String name, NetworkConnectOptions 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 -
      404 No such network -
      500 Internal server error -
    • networkConnectLibpodAsync

      public okhttp3.Call networkConnectLibpodAsync(String name, NetworkConnectOptions 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 -
      404 No such network -
      500 Internal server error -
    • networkCreateLibpodCall

      public okhttp3.Call networkCreateLibpodCall(NetworkCreateLibpod create, ApiCallback _callback) throws ApiException
      Build call for networkCreateLibpod
      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
      200 Network create -
      400 Bad parameter in request -
      409 Conflict error in operation -
      500 Internal server error -
    • networkCreateLibpod

      public Network networkCreateLibpod(NetworkCreateLibpod create) throws ApiException
      Create network Create a new network configuration
      Parameters:
      create - attributes for creating a network (optional)
      Returns:
      Network
      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 create -
      400 Bad parameter in request -
      409 Conflict error in operation -
      500 Internal server error -
    • networkCreateLibpodWithHttpInfo

      public ApiResponse<Network> networkCreateLibpodWithHttpInfo(NetworkCreateLibpod create) throws ApiException
      Create network Create a new network configuration
      Parameters:
      create - attributes for creating a network (optional)
      Returns:
      ApiResponse<Network>
      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 create -
      400 Bad parameter in request -
      409 Conflict error in operation -
      500 Internal server error -
    • networkCreateLibpodAsync

      public okhttp3.Call networkCreateLibpodAsync(NetworkCreateLibpod create, ApiCallback<Network> _callback) throws ApiException
      Create network (asynchronously) Create a new 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
      200 Network create -
      400 Bad parameter in request -
      409 Conflict error in operation -
      500 Internal server error -
    • networkDeleteLibpodCall

      public okhttp3.Call networkDeleteLibpodCall(String name, Boolean force, ApiCallback _callback) throws ApiException
      Build call for networkDeleteLibpod
      Parameters:
      name - the name of the network (required)
      force - remove containers associated with 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 Network Delete -
      404 No such network -
      500 Internal server error -
    • networkDeleteLibpod

      public List<NetworkRmReport> networkDeleteLibpod(String name, Boolean force) throws ApiException
      Remove a network Remove a configured network
      Parameters:
      name - the name of the network (required)
      force - remove containers associated with network (optional)
      Returns:
      List<NetworkRmReport>
      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 Delete -
      404 No such network -
      500 Internal server error -
    • networkDeleteLibpodWithHttpInfo

      public ApiResponse<List<NetworkRmReport>> networkDeleteLibpodWithHttpInfo(String name, Boolean force) throws ApiException
      Remove a network Remove a configured network
      Parameters:
      name - the name of the network (required)
      force - remove containers associated with network (optional)
      Returns:
      ApiResponse<List<NetworkRmReport>>
      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 Delete -
      404 No such network -
      500 Internal server error -
    • networkDeleteLibpodAsync

      public okhttp3.Call networkDeleteLibpodAsync(String name, Boolean force, ApiCallback<List<NetworkRmReport>> _callback) throws ApiException
      Remove a network (asynchronously) Remove a configured network
      Parameters:
      name - the name of the network (required)
      force - remove containers associated with 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 Network Delete -
      404 No such network -
      500 Internal server error -
    • networkDisconnectLibpodCall

      public okhttp3.Call networkDisconnectLibpodCall(String name, DisconnectOptions create, ApiCallback _callback) throws ApiException
      Build call for networkDisconnectLibpod
      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 -
      404 No such network -
      500 Internal server error -
    • networkDisconnectLibpod

      public void networkDisconnectLibpod(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 -
      404 No such network -
      500 Internal server error -
    • networkDisconnectLibpodWithHttpInfo

      public ApiResponse<Void> networkDisconnectLibpodWithHttpInfo(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 -
      404 No such network -
      500 Internal server error -
    • networkDisconnectLibpodAsync

      public okhttp3.Call networkDisconnectLibpodAsync(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 -
      404 No such network -
      500 Internal server error -
    • networkExistsLibpodCall

      public okhttp3.Call networkExistsLibpodCall(String name, ApiCallback _callback) throws ApiException
      Build call for networkExistsLibpod
      Parameters:
      name - the name or ID 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 network exists -
      404 No such network -
      500 Internal server error -
    • networkExistsLibpod

      public void networkExistsLibpod(String name) throws ApiException
      Network exists Check if network exists
      Parameters:
      name - the name or ID 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 network exists -
      404 No such network -
      500 Internal server error -
    • networkExistsLibpodWithHttpInfo

      public ApiResponse<Void> networkExistsLibpodWithHttpInfo(String name) throws ApiException
      Network exists Check if network exists
      Parameters:
      name - the name or ID 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 network exists -
      404 No such network -
      500 Internal server error -
    • networkExistsLibpodAsync

      public okhttp3.Call networkExistsLibpodAsync(String name, ApiCallback<Void> _callback) throws ApiException
      Network exists (asynchronously) Check if network exists
      Parameters:
      name - the name or ID 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 network exists -
      404 No such network -
      500 Internal server error -
    • networkInspectLibpodCall

      public okhttp3.Call networkInspectLibpodCall(String name, ApiCallback _callback) throws ApiException
      Build call for networkInspectLibpod
      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
      200 Network inspect -
      404 No such network -
      500 Internal server error -
    • networkInspectLibpod

      public NetworkInspectReport networkInspectLibpod(String name) throws ApiException
      Inspect a network Display configuration for a network.
      Parameters:
      name - the name of the network (required)
      Returns:
      NetworkInspectReport
      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 -
    • networkInspectLibpodWithHttpInfo

      public ApiResponse<NetworkInspectReport> networkInspectLibpodWithHttpInfo(String name) throws ApiException
      Inspect a network Display configuration for a network.
      Parameters:
      name - the name of the network (required)
      Returns:
      ApiResponse<NetworkInspectReport>
      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 -
    • networkInspectLibpodAsync

      public okhttp3.Call networkInspectLibpodAsync(String name, ApiCallback<NetworkInspectReport> _callback) throws ApiException
      Inspect a network (asynchronously) Display configuration for 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
      200 Network inspect -
      404 No such network -
      500 Internal server error -
    • networkListLibpodCall

      public okhttp3.Call networkListLibpodCall(String filters, ApiCallback _callback) throws ApiException
      Build call for networkListLibpod
      Parameters:
      filters - JSON encoded value of the filters (a `map[string][]string`) to process on the network list. 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. - `until=[timestamp]` Matches all networks that were created before the given timestamp. (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 -
    • networkListLibpod

      public List<Network> networkListLibpod(String filters) throws ApiException
      List networks Display summary of network configurations. - In a 200 response, all of the fields named Bytes are returned as a Base64 encoded string.
      Parameters:
      filters - JSON encoded value of the filters (a `map[string][]string`) to process on the network list. 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. - `until=[timestamp]` Matches all networks that were created before the given timestamp. (optional)
      Returns:
      List<Network>
      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 -
    • networkListLibpodWithHttpInfo

      public ApiResponse<List<Network>> networkListLibpodWithHttpInfo(String filters) throws ApiException
      List networks Display summary of network configurations. - In a 200 response, all of the fields named Bytes are returned as a Base64 encoded string.
      Parameters:
      filters - JSON encoded value of the filters (a `map[string][]string`) to process on the network list. 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. - `until=[timestamp]` Matches all networks that were created before the given timestamp. (optional)
      Returns:
      ApiResponse<List<Network>>
      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 -
    • networkListLibpodAsync

      public okhttp3.Call networkListLibpodAsync(String filters, ApiCallback<List<Network>> _callback) throws ApiException
      List networks (asynchronously) Display summary of network configurations. - In a 200 response, all of the fields named Bytes are returned as a Base64 encoded string.
      Parameters:
      filters - JSON encoded value of the filters (a `map[string][]string`) to process on the network list. 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. - `until=[timestamp]` Matches all networks that were created before the given timestamp. (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 -
    • networkPruneLibpodCall

      public okhttp3.Call networkPruneLibpodCall(String filters, ApiCallback _callback) throws ApiException
      Build call for networkPruneLibpod
      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 Network prune -
      500 Internal server error -
    • networkPruneLibpod

      public List<NetworkPruneReport> networkPruneLibpod(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:
      List<NetworkPruneReport>
      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 prune -
      500 Internal server error -
    • networkPruneLibpodWithHttpInfo

      public ApiResponse<List<NetworkPruneReport>> networkPruneLibpodWithHttpInfo(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<List<NetworkPruneReport>>
      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 prune -
      500 Internal server error -
    • networkPruneLibpodAsync

      public okhttp3.Call networkPruneLibpodAsync(String filters, ApiCallback<List<NetworkPruneReport>> _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 Network prune -
      500 Internal server error -
    • networkUpdateLibpodCall

      public okhttp3.Call networkUpdateLibpodCall(String name, NetworkUpdateOptions update, ApiCallback _callback) throws ApiException
      Build call for networkUpdateLibpod
      Parameters:
      name - the name or ID of the network (required)
      update - attributes for updating a netavark 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 -
    • networkUpdateLibpod

      public void networkUpdateLibpod(String name, NetworkUpdateOptions update) throws ApiException
      Update existing podman network Update existing podman network
      Parameters:
      name - the name or ID of the network (required)
      update - attributes for updating a netavark 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 -
    • networkUpdateLibpodWithHttpInfo

      public ApiResponse<Void> networkUpdateLibpodWithHttpInfo(String name, NetworkUpdateOptions update) throws ApiException
      Update existing podman network Update existing podman network
      Parameters:
      name - the name or ID of the network (required)
      update - attributes for updating a netavark 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 -
    • networkUpdateLibpodAsync

      public okhttp3.Call networkUpdateLibpodAsync(String name, NetworkUpdateOptions update, ApiCallback<Void> _callback) throws ApiException
      Update existing podman network (asynchronously) Update existing podman network
      Parameters:
      name - the name or ID of the network (required)
      update - attributes for updating a netavark 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 -