Class ImagesApi
java.lang.Object
io.github.alersrt.pod4j.openapi.api.ImagesApi
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionclassclassclassclassclassclassclassclassclassclassclassclassclassclassclassclassclassclassclassclassclass -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintCreate image Build an image from the given Dockerfile(s)imageChangesLibpod(String name) Report on changes to images's filesystem; adds, deletes or modifications.Remove one or more images from the storage.imageDeleteLibpod(String name) Remove an image from the local storage.imageExistsLibpod(String name) Image exists Check if image exists in local storeExport multiple images Export multiple images into a single object.imageGetLibpod(String name) Export an image Export an imageimageHistoryLibpod(String name) History of an image Return parent layers of an image.imageImportLibpod(File upload) Import image Import a previously exported tarball as an image.imageInspectLibpod(String name) Inspect an image Obtain low-level information about an imageList Images Returns a list of images on the serverimageLoadLibpod(String upload) Load image Load an image (oci-archive or docker-archive) stream.Prune unused images Remove images that are not being used by a containerPull images Pull one or more images from a container registry.imagePushLibpod(String name) Push Image Push an image to a container registryimageResolveLibpod(String name) Resolve an image (short) name Resolve the passed image name to a list of fully-qualified images referring to container registries.imageScpLibpod(String name) Copy an image from one host to another Copy an image from one host to anotherSearch images Search registries for imagesimageTagLibpod(String name) Tag an image Tag an image so that it becomes part of a repository.imageTreeLibpod(String name) Image tree Retrieve the image tree for the provided image name or IDimageUntagLibpod(String name) Untag an image Untag an image.voidsetApiClient(ApiClient apiClient) voidsetCustomBaseUrl(String customBaseUrl) voidsetHostIndex(int hostIndex)
-
Constructor Details
-
ImagesApi
public ImagesApi() -
ImagesApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
getHostIndex
public int getHostIndex() -
setHostIndex
public void setHostIndex(int hostIndex) -
getCustomBaseUrl
-
setCustomBaseUrl
-
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Search images Search registries for images- Returns:
- APIimageSearchLibpodRequest
- Http Response Details
Status Code Description Response Headers 200 Registry Search - 500 Internal server error -
-
imageTagLibpod
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
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
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 -
-