Class ImagesApi

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

public class ImagesApi extends Object
  • Constructor Details

    • ImagesApi

      public ImagesApi()
    • ImagesApi

      public ImagesApi(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)
    • imageBuildLibpod

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

      public ImagesApi.APIimageChangesLibpodRequest imageChangesLibpod(String name)
      Report on changes to images's filesystem; adds, deletes or modifications. Returns which files in an image's filesystem have been added, deleted, or modified. The Kind of modification can be one of: 0: Modified 1: Added 2: Deleted
      Parameters:
      name - the name or id of the image (required)
      Returns:
      APIimageChangesLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      200 Array of Changes -
      404 No such container -
      500 Internal server error -
    • imageDeleteAllLibpod

      public ImagesApi.APIimageDeleteAllLibpodRequest imageDeleteAllLibpod()
      Remove one or more images from the storage. Remove one or more images from the storage.
      Returns:
      APIimageDeleteAllLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      200 Image Remove -
      400 Bad parameter in request -
      500 Internal server error -
    • imageDeleteLibpod

      public ImagesApi.APIimageDeleteLibpodRequest imageDeleteLibpod(String name)
      Remove an image from the local storage. Remove an image from the local storage.
      Parameters:
      name - name or ID of image to remove (required)
      Returns:
      APIimageDeleteLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      200 Image Remove -
      400 Bad parameter in request -
      404 No such image -
      409 Conflict error in operation -
      500 Internal server error -
    • imageExistsLibpod

      public ImagesApi.APIimageExistsLibpodRequest imageExistsLibpod(String name)
      Image exists Check if image exists in local store
      Parameters:
      name - the name or ID of the container (required)
      Returns:
      APIimageExistsLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      204 image exists -
      404 No such image -
      500 Internal server error -
    • imageExportLibpod

      public ImagesApi.APIimageExportLibpodRequest imageExportLibpod()
      Export multiple images Export multiple images into a single object. Only `docker-archive` is currently supported.
      Returns:
      APIimageExportLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      200 no error -
      404 No such image -
      500 Internal server error -
    • imageGetLibpod

      public ImagesApi.APIimageGetLibpodRequest imageGetLibpod(String name)
      Export an image Export an image
      Parameters:
      name - the name or ID of the container (required)
      Returns:
      APIimageGetLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      200 no error -
      404 No such image -
      500 Internal server error -
    • imageHistoryLibpod

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

      public ImagesApi.APIimageImportLibpodRequest imageImportLibpod(File upload)
      Import image Import a previously exported tarball as an image.
      Parameters:
      upload - tarball for imported image (required)
      Returns:
      APIimageImportLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      200 Image Import -
      400 Bad parameter in request -
      500 Internal server error -
    • imageInspectLibpod

      public ImagesApi.APIimageInspectLibpodRequest imageInspectLibpod(String name)
      Inspect an image Obtain low-level information about an image
      Parameters:
      name - the name or ID of the container (required)
      Returns:
      APIimageInspectLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      200 Inspect Image -
      404 No such image -
      500 Internal server error -
    • imageListLibpod

      public ImagesApi.APIimageListLibpodRequest imageListLibpod()
      List Images Returns a list of images on the server
      Returns:
      APIimageListLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      200 Image summary for libpod API -
      500 Internal server error -
    • imageLoadLibpod

      public ImagesApi.APIimageLoadLibpodRequest imageLoadLibpod(String upload)
      Load image Load an image (oci-archive or docker-archive) stream.
      Parameters:
      upload - tarball of container image (required)
      Returns:
      APIimageLoadLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      200 Image Load -
      400 Bad parameter in request -
      500 Internal server error -
    • imagePruneLibpod

      public ImagesApi.APIimagePruneLibpodRequest imagePruneLibpod()
      Prune unused images Remove images that are not being used by a container
      Returns:
      APIimagePruneLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      200 Image Prune -
      500 Internal server error -
    • imagePullLibpod

      public ImagesApi.APIimagePullLibpodRequest imagePullLibpod()
      Pull images Pull one or more images from a container registry.
      Returns:
      APIimagePullLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      200 Image Pull -
      400 Bad parameter in request -
      500 Internal server error -
    • imagePushLibpod

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

      public ImagesApi.APIimageResolveLibpodRequest imageResolveLibpod(String name)
      Resolve an image (short) name Resolve the passed image name to a list of fully-qualified images referring to container registries.
      Parameters:
      name - the (short) name to resolve (required)
      Returns:
      APIimageResolveLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      204 resolved image names -
      400 Bad parameter in request -
      500 Internal server error -
    • imageScpLibpod

      public ImagesApi.APIimageScpLibpodRequest imageScpLibpod(String name)
      Copy an image from one host to another Copy an image from one host to another
      Parameters:
      name - source connection/image (required)
      Returns:
      APIimageScpLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      200 Image Scp -
      400 Bad parameter in request -
      500 Internal server error -
    • imageSearchLibpod

      public ImagesApi.APIimageSearchLibpodRequest imageSearchLibpod()
      Search images Search registries for images
      Returns:
      APIimageSearchLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      200 Registry Search -
      500 Internal server error -
    • imageTagLibpod

      public ImagesApi.APIimageTagLibpodRequest imageTagLibpod(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:
      APIimageTagLibpodRequest
      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 -
    • imageTreeLibpod

      public ImagesApi.APIimageTreeLibpodRequest imageTreeLibpod(String name)
      Image tree Retrieve the image tree for the provided image name or ID
      Parameters:
      name - the name or ID of the container (required)
      Returns:
      APIimageTreeLibpodRequest
      Http Response Details
      Status Code Description Response Headers
      200 Image Tree -
      404 No such image -
      500 Internal server error -
    • imageUntagLibpod

      public ImagesApi.APIimageUntagLibpodRequest imageUntagLibpod(String name)
      Untag an image Untag an image. If not repo and tag are specified, all tags are removed from the image.
      Parameters:
      name - the name or ID of the container (required)
      Returns:
      APIimageUntagLibpodRequest
      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 -