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

Class ImagesCompatApi

java.lang.Object
io.github.alersrt.pod4j.openapi.api.ImagesCompatApi
public class ImagesCompatApi extends Object

  • Constructor Details

    • ImagesCompatApi

      public ImagesCompatApi()

    • ImagesCompatApi

      public ImagesCompatApi(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)

    • imageBuild

      public ImagesCompatApi.APIimageBuildRequest imageBuild()
      Create image Build an image from the given Dockerfile(s)
      Returns:
      APIimageBuildRequest
      Http Response Details
      Status Code Description Response Headers
      200 OK (As of version 1.xx) -
      400 Bad parameter in request -
      500 Internal server error -

    • imageCreate

      public ImagesCompatApi.APIimageCreateRequest imageCreate()
      Create an image Create an image by either pulling it from a registry or importing it.
      Returns:
      APIimageCreateRequest
      Http Response Details
      Status Code Description Response Headers
      200 no error -
      404 No such image -
      500 Internal server error -

    • imageDelete

      public ImagesCompatApi.APIimageDeleteRequest imageDelete(String name)
      Remove Image Delete an image from local storage
      Parameters:
      name - name or ID of image to delete (required)
      Returns:
      APIimageDeleteRequest
      Http Response Details
      Status Code Description Response Headers
      200 Image Delete -
      404 No such image -
      409 Conflict error in operation -
      500 Internal server error -

    • imageGet

      public ImagesCompatApi.APIimageGetRequest imageGet(String name)
      Export an image Export an image in tarball format
      Parameters:
      name - the name or ID of the container (required)
      Returns:
      APIimageGetRequest
      Http Response Details
      Status Code Description Response Headers
      200 no error -
      500 Internal server error -

    • imageGetAll

      public ImagesCompatApi.APIimageGetAllRequest imageGetAll(String names)
      Export several images Get a tarball containing all images and metadata for several image repositories
      Parameters:
      names - one or more image names or IDs comma separated (required)
      Returns:
      APIimageGetAllRequest
      Http Response Details
      Status Code Description Response Headers
      200 no error -
      500 Internal server error -

    • imageHistory

      public ImagesCompatApi.APIimageHistoryRequest imageHistory(String name)
      History of an image Return parent layers of an image.
      Parameters:
      name - the name or ID of the container (required)
      Returns:
      APIimageHistoryRequest
      Http Response Details
      Status Code Description Response Headers
      200 Image History -
      404 No such image -
      500 Internal server error -

    • imageInspect

      public ImagesCompatApi.APIimageInspectRequest imageInspect(String name)
      Inspect an image Return low-level information about an image.
      Parameters:
      name - the name or ID of the container (required)
      Returns:
      APIimageInspectRequest
      Http Response Details
      Status Code Description Response Headers
      200 Image Inspect -
      404 No such image -
      500 Internal server error -

    • imageList

      public ImagesCompatApi.APIimageListRequest imageList()
      List Images Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image.
      Returns:
      APIimageListRequest
      Http Response Details
      Status Code Description Response Headers
      200 Image summary for compat API -
      500 Internal server error -

    • imageLoad

      public ImagesCompatApi.APIimageLoadRequest imageLoad()
      Import image Load a set of images and tags into a repository.
      Returns:
      APIimageLoadRequest
      Http Response Details
      Status Code Description Response Headers
      200 no error -
      500 Internal server error -

    • imagePrune

      public ImagesCompatApi.APIimagePruneRequest imagePrune()
      Prune unused images Remove images from local storage that are not being used by a container
      Returns:
      APIimagePruneRequest
      Http Response Details
      Status Code Description Response Headers
      200 Image Delete -
      500 Internal server error -

    • imagePush

      public ImagesCompatApi.APIimagePushRequest imagePush(String name)
      Push Image Push an image to a container registry
      Parameters:
      name - Name of image to push. (required)
      Returns:
      APIimagePushRequest
      Http Response Details
      Status Code Description Response Headers
      200 no error -
      404 No such image -
      500 Internal server error -

    • imageSearch

      public ImagesCompatApi.APIimageSearchRequest imageSearch()
      Search images Search registries for an image
      Returns:
      APIimageSearchRequest
      Http Response Details
      Status Code Description Response Headers
      200 Registry Search -
      400 Bad parameter in request -
      500 Internal server error -

    • imageTag

      public ImagesCompatApi.APIimageTagRequest imageTag(String name)
      Tag an image Tag an image so that it becomes part of a repository.
      Parameters:
      name - the name or ID of the container (required)
      Returns:
      APIimageTagRequest
      Http Response Details
      Status Code Description Response Headers
      201 no error -
      400 Bad parameter in request -
      404 No such image -
      409 Conflict error in operation -
      500 Internal server error -