Class ImagesApi
java.lang.Object
io.github.alersrt.pod4j.openapi.api.ImagesApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintimageBuildLibpod(String dockerfile, String t, Boolean allplatforms, String extrahosts, String remote, Boolean q, Boolean compatvolumes, Boolean nocache, String cachefrom, Boolean pull, Boolean rm, Boolean forcerm, Integer memory, Integer memswap, Integer cpushares, String cpusetcpus, Integer cpuperiod, Integer cpuquota, String buildargs, Integer shmsize, Boolean squash, String labels, List<String> layerLabel, Boolean layers, String networkmode, String platform, String target, String outputs, Boolean httpproxy, List<String> unsetenv, List<String> unsetlabel, List<String> volume) Create image Build an image from the given Dockerfile(s)okhttp3.CallimageBuildLibpodAsync(String dockerfile, String t, Boolean allplatforms, String extrahosts, String remote, Boolean q, Boolean compatvolumes, Boolean nocache, String cachefrom, Boolean pull, Boolean rm, Boolean forcerm, Integer memory, Integer memswap, Integer cpushares, String cpusetcpus, Integer cpuperiod, Integer cpuquota, String buildargs, Integer shmsize, Boolean squash, String labels, List<String> layerLabel, Boolean layers, String networkmode, String platform, String target, String outputs, Boolean httpproxy, List<String> unsetenv, List<String> unsetlabel, List<String> volume, ApiCallback<ImageBuildLibpod200Response> _callback) Create image (asynchronously) Build an image from the given Dockerfile(s)okhttp3.CallimageBuildLibpodCall(String dockerfile, String t, Boolean allplatforms, String extrahosts, String remote, Boolean q, Boolean compatvolumes, Boolean nocache, String cachefrom, Boolean pull, Boolean rm, Boolean forcerm, Integer memory, Integer memswap, Integer cpushares, String cpusetcpus, Integer cpuperiod, Integer cpuquota, String buildargs, Integer shmsize, Boolean squash, String labels, List<String> layerLabel, Boolean layers, String networkmode, String platform, String target, String outputs, Boolean httpproxy, List<String> unsetenv, List<String> unsetlabel, List<String> volume, ApiCallback _callback) Build call for imageBuildLibpodimageBuildLibpodWithHttpInfo(String dockerfile, String t, Boolean allplatforms, String extrahosts, String remote, Boolean q, Boolean compatvolumes, Boolean nocache, String cachefrom, Boolean pull, Boolean rm, Boolean forcerm, Integer memory, Integer memswap, Integer cpushares, String cpusetcpus, Integer cpuperiod, Integer cpuquota, String buildargs, Integer shmsize, Boolean squash, String labels, List<String> layerLabel, Boolean layers, String networkmode, String platform, String target, String outputs, Boolean httpproxy, List<String> unsetenv, List<String> unsetlabel, List<String> volume) Create image Build an image from the given Dockerfile(s)voidimageChangesLibpod(String name, String parent, String diffType) Report on changes to images's filesystem; adds, deletes or modifications.okhttp3.CallimageChangesLibpodAsync(String name, String parent, String diffType, ApiCallback<Void> _callback) Report on changes to images's filesystem; adds, deletes or modifications.okhttp3.CallimageChangesLibpodCall(String name, String parent, String diffType, ApiCallback _callback) Build call for imageChangesLibpodimageChangesLibpodWithHttpInfo(String name, String parent, String diffType) Report on changes to images's filesystem; adds, deletes or modifications.imageDeleteAllLibpod(List<String> images, Boolean all, Boolean force, Boolean ignore, Boolean lookupManifest) Remove one or more images from the storage.okhttp3.CallimageDeleteAllLibpodAsync(List<String> images, Boolean all, Boolean force, Boolean ignore, Boolean lookupManifest, ApiCallback<LibpodImagesRemoveReport> _callback) Remove one or more images from the storage.okhttp3.CallimageDeleteAllLibpodCall(List<String> images, Boolean all, Boolean force, Boolean ignore, Boolean lookupManifest, ApiCallback _callback) Build call for imageDeleteAllLibpodimageDeleteAllLibpodWithHttpInfo(List<String> images, Boolean all, Boolean force, Boolean ignore, Boolean lookupManifest) Remove one or more images from the storage.imageDeleteLibpod(String name, Boolean force) Remove an image from the local storage.okhttp3.CallimageDeleteLibpodAsync(String name, Boolean force, ApiCallback<LibpodImagesRemoveReport> _callback) Remove an image from the local storage.okhttp3.CallimageDeleteLibpodCall(String name, Boolean force, ApiCallback _callback) Build call for imageDeleteLibpodimageDeleteLibpodWithHttpInfo(String name, Boolean force) Remove an image from the local storage.voidimageExistsLibpod(String name) Image exists Check if image exists in local storeokhttp3.CallimageExistsLibpodAsync(String name, ApiCallback<Void> _callback) Image exists (asynchronously) Check if image exists in local storeokhttp3.CallimageExistsLibpodCall(String name, ApiCallback _callback) Build call for imageExistsLibpodImage exists Check if image exists in local storeimageExportLibpod(String format, List<String> references, Boolean compress, Boolean ociAcceptUncompressedLayers) Export multiple images Export multiple images into a single object.okhttp3.CallimageExportLibpodAsync(String format, List<String> references, Boolean compress, Boolean ociAcceptUncompressedLayers, ApiCallback<File> _callback) Export multiple images (asynchronously) Export multiple images into a single object.okhttp3.CallimageExportLibpodCall(String format, List<String> references, Boolean compress, Boolean ociAcceptUncompressedLayers, ApiCallback _callback) Build call for imageExportLibpodimageExportLibpodWithHttpInfo(String format, List<String> references, Boolean compress, Boolean ociAcceptUncompressedLayers) Export multiple images Export multiple images into a single object.imageGetLibpod(String name, String format, Boolean compress) Export an image Export an imageokhttp3.CallimageGetLibpodAsync(String name, String format, Boolean compress, ApiCallback<File> _callback) Export an image (asynchronously) Export an imageokhttp3.CallimageGetLibpodCall(String name, String format, Boolean compress, ApiCallback _callback) Build call for imageGetLibpodimageGetLibpodWithHttpInfo(String name, String format, Boolean compress) Export an image Export an imageimageHistoryLibpod(String name) History of an image Return parent layers of an image.okhttp3.CallimageHistoryLibpodAsync(String name, ApiCallback<HistoryResponse> _callback) History of an image (asynchronously) Return parent layers of an image.okhttp3.CallimageHistoryLibpodCall(String name, ApiCallback _callback) Build call for imageHistoryLibpodHistory of an image Return parent layers of an image.imageImportLibpod(File upload, String contentType, List<String> changes, String message, String reference, String url) Import image Import a previously exported tarball as an image.okhttp3.CallimageImportLibpodAsync(File upload, String contentType, List<String> changes, String message, String reference, String url, ApiCallback<ImageImportReport> _callback) Import image (asynchronously) Import a previously exported tarball as an image.okhttp3.CallimageImportLibpodCall(File upload, String contentType, List<String> changes, String message, String reference, String url, ApiCallback _callback) Build call for imageImportLibpodimageImportLibpodWithHttpInfo(File upload, String contentType, List<String> changes, String message, String reference, String url) Import image Import a previously exported tarball as an image.imageInspectLibpod(String name) Inspect an image Obtain low-level information about an imageokhttp3.CallimageInspectLibpodAsync(String name, ApiCallback<ImageData> _callback) Inspect an image (asynchronously) Obtain low-level information about an imageokhttp3.CallimageInspectLibpodCall(String name, ApiCallback _callback) Build call for imageInspectLibpodInspect an image Obtain low-level information about an imageimageListLibpod(Boolean all, String filters) List Images Returns a list of images on the serverokhttp3.CallimageListLibpodAsync(Boolean all, String filters, ApiCallback<List<LibpodImageSummary>> _callback) List Images (asynchronously) Returns a list of images on the serverokhttp3.CallimageListLibpodCall(Boolean all, String filters, ApiCallback _callback) Build call for imageListLibpodimageListLibpodWithHttpInfo(Boolean all, String filters) List Images Returns a list of images on the serverimageLoadLibpod(String upload) Load image Load an image (oci-archive or docker-archive) stream.okhttp3.CallimageLoadLibpodAsync(String upload, ApiCallback<ImageLoadReport> _callback) Load image (asynchronously) Load an image (oci-archive or docker-archive) stream.okhttp3.CallimageLoadLibpodCall(String upload, ApiCallback _callback) Build call for imageLoadLibpodimageLoadLibpodWithHttpInfo(String upload) Load image Load an image (oci-archive or docker-archive) stream.imagePruneLibpod(Boolean all, Boolean external, Boolean buildcache, String filters) Prune unused images Remove images that are not being used by a containerokhttp3.CallimagePruneLibpodAsync(Boolean all, Boolean external, Boolean buildcache, String filters, ApiCallback<List<PruneReport>> _callback) Prune unused images (asynchronously) Remove images that are not being used by a containerokhttp3.CallimagePruneLibpodCall(Boolean all, Boolean external, Boolean buildcache, String filters, ApiCallback _callback) Build call for imagePruneLibpodimagePruneLibpodWithHttpInfo(Boolean all, Boolean external, Boolean buildcache, String filters) Prune unused images Remove images that are not being used by a containerimagePullLibpod(String reference, Boolean quiet, Boolean compatMode, String arch, String OS, String variant, String policy, Boolean tlsVerify, Boolean allTags, String xRegistryAuth) Pull images Pull one or more images from a container registry.okhttp3.CallimagePullLibpodAsync(String reference, Boolean quiet, Boolean compatMode, String arch, String OS, String variant, String policy, Boolean tlsVerify, Boolean allTags, String xRegistryAuth, ApiCallback<LibpodImagesPullReport> _callback) Pull images (asynchronously) Pull one or more images from a container registry.okhttp3.CallimagePullLibpodCall(String reference, Boolean quiet, Boolean compatMode, String arch, String OS, String variant, String policy, Boolean tlsVerify, Boolean allTags, String xRegistryAuth, ApiCallback _callback) Build call for imagePullLibpodimagePullLibpodWithHttpInfo(String reference, Boolean quiet, Boolean compatMode, String arch, String OS, String variant, String policy, Boolean tlsVerify, Boolean allTags, String xRegistryAuth) Pull images Pull one or more images from a container registry.imagePushLibpod(String name, String destination, Boolean forceCompressionFormat, String compressionFormat, Integer compressionLevel, Boolean tlsVerify, Boolean quiet, String format, Boolean all, Boolean removeSignatures, Integer retry, String retryDelay, String xRegistryAuth) Push Image Push an image to a container registryokhttp3.CallimagePushLibpodAsync(String name, String destination, Boolean forceCompressionFormat, String compressionFormat, Integer compressionLevel, Boolean tlsVerify, Boolean quiet, String format, Boolean all, Boolean removeSignatures, Integer retry, String retryDelay, String xRegistryAuth, ApiCallback<File> _callback) Push Image (asynchronously) Push an image to a container registryokhttp3.CallimagePushLibpodCall(String name, String destination, Boolean forceCompressionFormat, String compressionFormat, Integer compressionLevel, Boolean tlsVerify, Boolean quiet, String format, Boolean all, Boolean removeSignatures, Integer retry, String retryDelay, String xRegistryAuth, ApiCallback _callback) Build call for imagePushLibpodimagePushLibpodWithHttpInfo(String name, String destination, Boolean forceCompressionFormat, String compressionFormat, Integer compressionLevel, Boolean tlsVerify, Boolean quiet, String format, Boolean all, Boolean removeSignatures, Integer retry, String retryDelay, String xRegistryAuth) Push Image Push an image to a container registryvoidimageResolveLibpod(String name) Resolve an image (short) name Resolve the passed image name to a list of fully-qualified images referring to container registries.okhttp3.CallimageResolveLibpodAsync(String name, ApiCallback<Void> _callback) Resolve an image (short) name (asynchronously) Resolve the passed image name to a list of fully-qualified images referring to container registries.okhttp3.CallimageResolveLibpodCall(String name, ApiCallback _callback) Build call for imageResolveLibpodResolve an image (short) name Resolve the passed image name to a list of fully-qualified images referring to container registries.imageScpLibpod(String name, String destination, Boolean quiet) Copy an image from one host to another Copy an image from one host to anotherokhttp3.CallimageScpLibpodAsync(String name, String destination, Boolean quiet, ApiCallback<ScpReport> _callback) Copy an image from one host to another (asynchronously) Copy an image from one host to anotherokhttp3.CallimageScpLibpodCall(String name, String destination, Boolean quiet, ApiCallback _callback) Build call for imageScpLibpodimageScpLibpodWithHttpInfo(String name, String destination, Boolean quiet) Copy an image from one host to another Copy an image from one host to anotherSearch images Search registries for imagesokhttp3.CallimageSearchLibpodAsync(String term, Integer limit, String filters, Boolean tlsVerify, Boolean listTags, ApiCallback<ImageSearch200Response> _callback) Search images (asynchronously) Search registries for imagesokhttp3.CallimageSearchLibpodCall(String term, Integer limit, String filters, Boolean tlsVerify, Boolean listTags, ApiCallback _callback) Build call for imageSearchLibpodimageSearchLibpodWithHttpInfo(String term, Integer limit, String filters, Boolean tlsVerify, Boolean listTags) Search images Search registries for imagesvoidimageTagLibpod(String name, String repo, String tag) Tag an image Tag an image so that it becomes part of a repository.okhttp3.CallimageTagLibpodAsync(String name, String repo, String tag, ApiCallback<Void> _callback) Tag an image (asynchronously) Tag an image so that it becomes part of a repository.okhttp3.CallimageTagLibpodCall(String name, String repo, String tag, ApiCallback _callback) Build call for imageTagLibpodimageTagLibpodWithHttpInfo(String name, String repo, String tag) Tag an image Tag an image so that it becomes part of a repository.imageTreeLibpod(String name, Boolean whatrequires) Image tree Retrieve the image tree for the provided image name or IDokhttp3.CallimageTreeLibpodAsync(String name, Boolean whatrequires, ApiCallback<ImageTreeReport> _callback) Image tree (asynchronously) Retrieve the image tree for the provided image name or IDokhttp3.CallimageTreeLibpodCall(String name, Boolean whatrequires, ApiCallback _callback) Build call for imageTreeLibpodimageTreeLibpodWithHttpInfo(String name, Boolean whatrequires) Image tree Retrieve the image tree for the provided image name or IDvoidimageUntagLibpod(String name, String repo, String tag) Untag an image Untag an image.okhttp3.CallimageUntagLibpodAsync(String name, String repo, String tag, ApiCallback<Void> _callback) Untag an image (asynchronously) Untag an image.okhttp3.CallimageUntagLibpodCall(String name, String repo, String tag, ApiCallback _callback) Build call for imageUntagLibpodimageUntagLibpodWithHttpInfo(String name, String repo, String tag) 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
-
imageBuildLibpodCall
public okhttp3.Call imageBuildLibpodCall(String dockerfile, String t, Boolean allplatforms, String extrahosts, String remote, Boolean q, Boolean compatvolumes, Boolean nocache, String cachefrom, Boolean pull, Boolean rm, Boolean forcerm, Integer memory, Integer memswap, Integer cpushares, String cpusetcpus, Integer cpuperiod, Integer cpuquota, String buildargs, Integer shmsize, Boolean squash, String labels, List<String> layerLabel, Boolean layers, String networkmode, String platform, String target, String outputs, Boolean httpproxy, List<String> unsetenv, List<String> unsetlabel, List<String> volume, ApiCallback _callback) throws ApiException Build call for imageBuildLibpod- Parameters:
dockerfile- Path within the build context to the `Dockerfile`. This is ignored if remote is specified and points to an external `Dockerfile`. (optional, default to Dockerfile)t- A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag, the default latest value is assumed. You can provide several t parameters. (optional, default to latest)allplatforms- Instead of building for a set of platforms specified using the platform option, inspect the build's base images, and build for all of the platforms that are available. Stages that use *scratch* as a starting point can not be inspected, so at least one non-*scratch* stage must be present for detection to work usefully. (optional, default to false)extrahosts- TBD Extra hosts to add to /etc/hosts (As of version 1.xx) (optional)remote- A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file’s contents are placed into a file called Dockerfile and the image is built from that file. If the URI points to a tarball, the file is downloaded by the daemon and the contents therein used as the context for the build. If the URI points to a tarball and the dockerfile parameter is also specified, there must be a file with the corresponding path inside the tarball. (As of version 1.xx) (optional)q- Suppress verbose build output (optional, default to false)compatvolumes- Contents of base images to be modified on ADD or COPY only (As of Podman version v5.2) (optional, default to false)nocache- Do not use the cache when building the image (As of version 1.xx) (optional, default to false)cachefrom- JSON array of images used to build cache resolution (As of version 1.xx) (optional)pull- Attempt to pull the image even if an older image exists locally (As of version 1.xx) (optional, default to false)rm- Remove intermediate containers after a successful build (As of version 1.xx) (optional, default to true)forcerm- Always remove intermediate containers, even upon failure (As of version 1.xx) (optional, default to false)memory- Memory is the upper limit (in bytes) on how much memory running containers can use (As of version 1.xx) (optional)memswap- MemorySwap limits the amount of memory and swap together (As of version 1.xx) (optional)cpushares- CPUShares (relative weight (As of version 1.xx) (optional)cpusetcpus- CPUSetCPUs in which to allow execution (0-3, 0,1) (As of version 1.xx) (optional)cpuperiod- CPUPeriod limits the CPU CFS (Completely Fair Scheduler) period (As of version 1.xx) (optional)cpuquota- CPUQuota limits the CPU CFS (Completely Fair Scheduler) quota (As of version 1.xx) (optional)buildargs- JSON map of string pairs denoting build-time variables. For example, the build argument `Foo` with the value of `bar` would be encoded in JSON as `[\"Foo\":\"bar\"]`. For example, buildargs={\"Foo\":\"bar\"}. Note(s): * This should not be used to pass secrets. * The value of buildargs should be URI component encoded before being passed to the API. (As of version 1.xx) (optional)shmsize- ShmSize is the \"size\" value to use when mounting an shmfs on the container's /dev/shm directory. Default is 64MB (As of version 1.xx) (optional, default to 67108864)squash- Silently ignored. Squash the resulting images layers into a single layer (As of version 1.xx) (optional, default to false)labels- JSON map of key, value pairs to set as labels on the new image (As of version 1.xx) (optional)layerLabel- Add an intermediate image *label* (e.g. label=*value*) to the intermediate image metadata. (optional)layers- Cache intermediate layers during build. (As of version 1.xx) (optional, default to true)networkmode- Sets the networking mode for the run commands during build. Supported standard values are: * `bridge` limited to containers within a single host, port mapping required for external access * `host` no isolation between host and containers on this network * `none` disable all networking for this container * container:<nameOrID> share networking with given container ---All other values are assumed to be a custom network's name (As of version 1.xx) (optional, default to bridge)platform- Platform format os[/arch[/variant]] (As of version 1.xx) (optional)target- Target build stage (As of version 1.xx) (optional)outputs- output configuration TBD (As of version 1.xx) (optional)httpproxy- Inject http proxy environment variables into container (As of version 2.0.0) (optional)unsetenv- Unset environment variables from the final image. (optional)unsetlabel- Unset the image label, causing the label not to be inherited from the base image. (optional)volume- Extra volumes that should be mounted in the build container. (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 (As of version 1.xx) - 400 Bad parameter in request - 500 Internal server error -
-
imageBuildLibpod
public ImageBuildLibpod200Response imageBuildLibpod(String dockerfile, String t, Boolean allplatforms, String extrahosts, String remote, Boolean q, Boolean compatvolumes, Boolean nocache, String cachefrom, Boolean pull, Boolean rm, Boolean forcerm, Integer memory, Integer memswap, Integer cpushares, String cpusetcpus, Integer cpuperiod, Integer cpuquota, String buildargs, Integer shmsize, Boolean squash, String labels, List<String> layerLabel, Boolean layers, String networkmode, String platform, String target, String outputs, Boolean httpproxy, List<String> unsetenv, List<String> unsetlabel, List<String> volume) throws ApiException Create image Build an image from the given Dockerfile(s)- Parameters:
dockerfile- Path within the build context to the `Dockerfile`. This is ignored if remote is specified and points to an external `Dockerfile`. (optional, default to Dockerfile)t- A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag, the default latest value is assumed. You can provide several t parameters. (optional, default to latest)allplatforms- Instead of building for a set of platforms specified using the platform option, inspect the build's base images, and build for all of the platforms that are available. Stages that use *scratch* as a starting point can not be inspected, so at least one non-*scratch* stage must be present for detection to work usefully. (optional, default to false)extrahosts- TBD Extra hosts to add to /etc/hosts (As of version 1.xx) (optional)remote- A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file’s contents are placed into a file called Dockerfile and the image is built from that file. If the URI points to a tarball, the file is downloaded by the daemon and the contents therein used as the context for the build. If the URI points to a tarball and the dockerfile parameter is also specified, there must be a file with the corresponding path inside the tarball. (As of version 1.xx) (optional)q- Suppress verbose build output (optional, default to false)compatvolumes- Contents of base images to be modified on ADD or COPY only (As of Podman version v5.2) (optional, default to false)nocache- Do not use the cache when building the image (As of version 1.xx) (optional, default to false)cachefrom- JSON array of images used to build cache resolution (As of version 1.xx) (optional)pull- Attempt to pull the image even if an older image exists locally (As of version 1.xx) (optional, default to false)rm- Remove intermediate containers after a successful build (As of version 1.xx) (optional, default to true)forcerm- Always remove intermediate containers, even upon failure (As of version 1.xx) (optional, default to false)memory- Memory is the upper limit (in bytes) on how much memory running containers can use (As of version 1.xx) (optional)memswap- MemorySwap limits the amount of memory and swap together (As of version 1.xx) (optional)cpushares- CPUShares (relative weight (As of version 1.xx) (optional)cpusetcpus- CPUSetCPUs in which to allow execution (0-3, 0,1) (As of version 1.xx) (optional)cpuperiod- CPUPeriod limits the CPU CFS (Completely Fair Scheduler) period (As of version 1.xx) (optional)cpuquota- CPUQuota limits the CPU CFS (Completely Fair Scheduler) quota (As of version 1.xx) (optional)buildargs- JSON map of string pairs denoting build-time variables. For example, the build argument `Foo` with the value of `bar` would be encoded in JSON as `[\"Foo\":\"bar\"]`. For example, buildargs={\"Foo\":\"bar\"}. Note(s): * This should not be used to pass secrets. * The value of buildargs should be URI component encoded before being passed to the API. (As of version 1.xx) (optional)shmsize- ShmSize is the \"size\" value to use when mounting an shmfs on the container's /dev/shm directory. Default is 64MB (As of version 1.xx) (optional, default to 67108864)squash- Silently ignored. Squash the resulting images layers into a single layer (As of version 1.xx) (optional, default to false)labels- JSON map of key, value pairs to set as labels on the new image (As of version 1.xx) (optional)layerLabel- Add an intermediate image *label* (e.g. label=*value*) to the intermediate image metadata. (optional)layers- Cache intermediate layers during build. (As of version 1.xx) (optional, default to true)networkmode- Sets the networking mode for the run commands during build. Supported standard values are: * `bridge` limited to containers within a single host, port mapping required for external access * `host` no isolation between host and containers on this network * `none` disable all networking for this container * container:<nameOrID> share networking with given container ---All other values are assumed to be a custom network's name (As of version 1.xx) (optional, default to bridge)platform- Platform format os[/arch[/variant]] (As of version 1.xx) (optional)target- Target build stage (As of version 1.xx) (optional)outputs- output configuration TBD (As of version 1.xx) (optional)httpproxy- Inject http proxy environment variables into container (As of version 2.0.0) (optional)unsetenv- Unset environment variables from the final image. (optional)unsetlabel- Unset the image label, causing the label not to be inherited from the base image. (optional)volume- Extra volumes that should be mounted in the build container. (optional)- Returns:
- ImageBuildLibpod200Response
- 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 (As of version 1.xx) - 400 Bad parameter in request - 500 Internal server error -
-
imageBuildLibpodWithHttpInfo
public ApiResponse<ImageBuildLibpod200Response> imageBuildLibpodWithHttpInfo(String dockerfile, String t, Boolean allplatforms, String extrahosts, String remote, Boolean q, Boolean compatvolumes, Boolean nocache, String cachefrom, Boolean pull, Boolean rm, Boolean forcerm, Integer memory, Integer memswap, Integer cpushares, String cpusetcpus, Integer cpuperiod, Integer cpuquota, String buildargs, Integer shmsize, Boolean squash, String labels, List<String> layerLabel, Boolean layers, String networkmode, String platform, String target, String outputs, Boolean httpproxy, List<String> unsetenv, List<String> unsetlabel, List<String> volume) throws ApiException Create image Build an image from the given Dockerfile(s)- Parameters:
dockerfile- Path within the build context to the `Dockerfile`. This is ignored if remote is specified and points to an external `Dockerfile`. (optional, default to Dockerfile)t- A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag, the default latest value is assumed. You can provide several t parameters. (optional, default to latest)allplatforms- Instead of building for a set of platforms specified using the platform option, inspect the build's base images, and build for all of the platforms that are available. Stages that use *scratch* as a starting point can not be inspected, so at least one non-*scratch* stage must be present for detection to work usefully. (optional, default to false)extrahosts- TBD Extra hosts to add to /etc/hosts (As of version 1.xx) (optional)remote- A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file’s contents are placed into a file called Dockerfile and the image is built from that file. If the URI points to a tarball, the file is downloaded by the daemon and the contents therein used as the context for the build. If the URI points to a tarball and the dockerfile parameter is also specified, there must be a file with the corresponding path inside the tarball. (As of version 1.xx) (optional)q- Suppress verbose build output (optional, default to false)compatvolumes- Contents of base images to be modified on ADD or COPY only (As of Podman version v5.2) (optional, default to false)nocache- Do not use the cache when building the image (As of version 1.xx) (optional, default to false)cachefrom- JSON array of images used to build cache resolution (As of version 1.xx) (optional)pull- Attempt to pull the image even if an older image exists locally (As of version 1.xx) (optional, default to false)rm- Remove intermediate containers after a successful build (As of version 1.xx) (optional, default to true)forcerm- Always remove intermediate containers, even upon failure (As of version 1.xx) (optional, default to false)memory- Memory is the upper limit (in bytes) on how much memory running containers can use (As of version 1.xx) (optional)memswap- MemorySwap limits the amount of memory and swap together (As of version 1.xx) (optional)cpushares- CPUShares (relative weight (As of version 1.xx) (optional)cpusetcpus- CPUSetCPUs in which to allow execution (0-3, 0,1) (As of version 1.xx) (optional)cpuperiod- CPUPeriod limits the CPU CFS (Completely Fair Scheduler) period (As of version 1.xx) (optional)cpuquota- CPUQuota limits the CPU CFS (Completely Fair Scheduler) quota (As of version 1.xx) (optional)buildargs- JSON map of string pairs denoting build-time variables. For example, the build argument `Foo` with the value of `bar` would be encoded in JSON as `[\"Foo\":\"bar\"]`. For example, buildargs={\"Foo\":\"bar\"}. Note(s): * This should not be used to pass secrets. * The value of buildargs should be URI component encoded before being passed to the API. (As of version 1.xx) (optional)shmsize- ShmSize is the \"size\" value to use when mounting an shmfs on the container's /dev/shm directory. Default is 64MB (As of version 1.xx) (optional, default to 67108864)squash- Silently ignored. Squash the resulting images layers into a single layer (As of version 1.xx) (optional, default to false)labels- JSON map of key, value pairs to set as labels on the new image (As of version 1.xx) (optional)layerLabel- Add an intermediate image *label* (e.g. label=*value*) to the intermediate image metadata. (optional)layers- Cache intermediate layers during build. (As of version 1.xx) (optional, default to true)networkmode- Sets the networking mode for the run commands during build. Supported standard values are: * `bridge` limited to containers within a single host, port mapping required for external access * `host` no isolation between host and containers on this network * `none` disable all networking for this container * container:<nameOrID> share networking with given container ---All other values are assumed to be a custom network's name (As of version 1.xx) (optional, default to bridge)platform- Platform format os[/arch[/variant]] (As of version 1.xx) (optional)target- Target build stage (As of version 1.xx) (optional)outputs- output configuration TBD (As of version 1.xx) (optional)httpproxy- Inject http proxy environment variables into container (As of version 2.0.0) (optional)unsetenv- Unset environment variables from the final image. (optional)unsetlabel- Unset the image label, causing the label not to be inherited from the base image. (optional)volume- Extra volumes that should be mounted in the build container. (optional)- Returns:
- ApiResponse<ImageBuildLibpod200Response>
- 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 (As of version 1.xx) - 400 Bad parameter in request - 500 Internal server error -
-
imageBuildLibpodAsync
public okhttp3.Call imageBuildLibpodAsync(String dockerfile, String t, Boolean allplatforms, String extrahosts, String remote, Boolean q, Boolean compatvolumes, Boolean nocache, String cachefrom, Boolean pull, Boolean rm, Boolean forcerm, Integer memory, Integer memswap, Integer cpushares, String cpusetcpus, Integer cpuperiod, Integer cpuquota, String buildargs, Integer shmsize, Boolean squash, String labels, List<String> layerLabel, Boolean layers, String networkmode, String platform, String target, String outputs, Boolean httpproxy, List<String> unsetenv, List<String> unsetlabel, List<String> volume, ApiCallback<ImageBuildLibpod200Response> _callback) throws ApiException Create image (asynchronously) Build an image from the given Dockerfile(s)- Parameters:
dockerfile- Path within the build context to the `Dockerfile`. This is ignored if remote is specified and points to an external `Dockerfile`. (optional, default to Dockerfile)t- A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag, the default latest value is assumed. You can provide several t parameters. (optional, default to latest)allplatforms- Instead of building for a set of platforms specified using the platform option, inspect the build's base images, and build for all of the platforms that are available. Stages that use *scratch* as a starting point can not be inspected, so at least one non-*scratch* stage must be present for detection to work usefully. (optional, default to false)extrahosts- TBD Extra hosts to add to /etc/hosts (As of version 1.xx) (optional)remote- A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file’s contents are placed into a file called Dockerfile and the image is built from that file. If the URI points to a tarball, the file is downloaded by the daemon and the contents therein used as the context for the build. If the URI points to a tarball and the dockerfile parameter is also specified, there must be a file with the corresponding path inside the tarball. (As of version 1.xx) (optional)q- Suppress verbose build output (optional, default to false)compatvolumes- Contents of base images to be modified on ADD or COPY only (As of Podman version v5.2) (optional, default to false)nocache- Do not use the cache when building the image (As of version 1.xx) (optional, default to false)cachefrom- JSON array of images used to build cache resolution (As of version 1.xx) (optional)pull- Attempt to pull the image even if an older image exists locally (As of version 1.xx) (optional, default to false)rm- Remove intermediate containers after a successful build (As of version 1.xx) (optional, default to true)forcerm- Always remove intermediate containers, even upon failure (As of version 1.xx) (optional, default to false)memory- Memory is the upper limit (in bytes) on how much memory running containers can use (As of version 1.xx) (optional)memswap- MemorySwap limits the amount of memory and swap together (As of version 1.xx) (optional)cpushares- CPUShares (relative weight (As of version 1.xx) (optional)cpusetcpus- CPUSetCPUs in which to allow execution (0-3, 0,1) (As of version 1.xx) (optional)cpuperiod- CPUPeriod limits the CPU CFS (Completely Fair Scheduler) period (As of version 1.xx) (optional)cpuquota- CPUQuota limits the CPU CFS (Completely Fair Scheduler) quota (As of version 1.xx) (optional)buildargs- JSON map of string pairs denoting build-time variables. For example, the build argument `Foo` with the value of `bar` would be encoded in JSON as `[\"Foo\":\"bar\"]`. For example, buildargs={\"Foo\":\"bar\"}. Note(s): * This should not be used to pass secrets. * The value of buildargs should be URI component encoded before being passed to the API. (As of version 1.xx) (optional)shmsize- ShmSize is the \"size\" value to use when mounting an shmfs on the container's /dev/shm directory. Default is 64MB (As of version 1.xx) (optional, default to 67108864)squash- Silently ignored. Squash the resulting images layers into a single layer (As of version 1.xx) (optional, default to false)labels- JSON map of key, value pairs to set as labels on the new image (As of version 1.xx) (optional)layerLabel- Add an intermediate image *label* (e.g. label=*value*) to the intermediate image metadata. (optional)layers- Cache intermediate layers during build. (As of version 1.xx) (optional, default to true)networkmode- Sets the networking mode for the run commands during build. Supported standard values are: * `bridge` limited to containers within a single host, port mapping required for external access * `host` no isolation between host and containers on this network * `none` disable all networking for this container * container:<nameOrID> share networking with given container ---All other values are assumed to be a custom network's name (As of version 1.xx) (optional, default to bridge)platform- Platform format os[/arch[/variant]] (As of version 1.xx) (optional)target- Target build stage (As of version 1.xx) (optional)outputs- output configuration TBD (As of version 1.xx) (optional)httpproxy- Inject http proxy environment variables into container (As of version 2.0.0) (optional)unsetenv- Unset environment variables from the final image. (optional)unsetlabel- Unset the image label, causing the label not to be inherited from the base image. (optional)volume- Extra volumes that should be mounted in the build container. (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 (As of version 1.xx) - 400 Bad parameter in request - 500 Internal server error -
-
imageChangesLibpodCall
public okhttp3.Call imageChangesLibpodCall(String name, String parent, String diffType, ApiCallback _callback) throws ApiException Build call for imageChangesLibpod- Parameters:
name- the name or id of the image (required)parent- specify a second layer which is used to compare against it instead of the parent layer (optional)diffType- select what you want to match, default is all (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 Array of Changes - 404 No such container - 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)parent- specify a second layer which is used to compare against it instead of the parent layer (optional)diffType- select what you want to match, default is all (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 Array of Changes - 404 No such container - 500 Internal server error -
-
imageChangesLibpodWithHttpInfo
public ApiResponse<Void> imageChangesLibpodWithHttpInfo(String name, String parent, String diffType) throws ApiException 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)parent- specify a second layer which is used to compare against it instead of the parent layer (optional)diffType- select what you want to match, default is all (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 Array of Changes - 404 No such container - 500 Internal server error -
-
imageChangesLibpodAsync
public okhttp3.Call imageChangesLibpodAsync(String name, String parent, String diffType, ApiCallback<Void> _callback) throws ApiException Report on changes to images's filesystem; adds, deletes or modifications. (asynchronously) 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)parent- specify a second layer which is used to compare against it instead of the parent layer (optional)diffType- select what you want to match, default is all (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 Array of Changes - 404 No such container - 500 Internal server error -
-
imageDeleteAllLibpodCall
public okhttp3.Call imageDeleteAllLibpodCall(List<String> images, Boolean all, Boolean force, Boolean ignore, Boolean lookupManifest, ApiCallback _callback) throws ApiException Build call for imageDeleteAllLibpod- Parameters:
images- Images IDs or names to remove. (optional)all- Remove all images. (optional, default to true)force- Force image removal (including containers using the images). (optional)ignore- Ignore if a specified image does not exist and do not throw an error. (optional)lookupManifest- Resolves to manifest list instead of image. (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 Image Remove - 400 Bad parameter in request - 500 Internal server error -
-
imageDeleteAllLibpod
public LibpodImagesRemoveReport imageDeleteAllLibpod(List<String> images, Boolean all, Boolean force, Boolean ignore, Boolean lookupManifest) throws ApiException Remove one or more images from the storage. Remove one or more images from the storage.- Parameters:
images- Images IDs or names to remove. (optional)all- Remove all images. (optional, default to true)force- Force image removal (including containers using the images). (optional)ignore- Ignore if a specified image does not exist and do not throw an error. (optional)lookupManifest- Resolves to manifest list instead of image. (optional)- Returns:
- LibpodImagesRemoveReport
- 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 Image Remove - 400 Bad parameter in request - 500 Internal server error -
-
imageDeleteAllLibpodWithHttpInfo
public ApiResponse<LibpodImagesRemoveReport> imageDeleteAllLibpodWithHttpInfo(List<String> images, Boolean all, Boolean force, Boolean ignore, Boolean lookupManifest) throws ApiException Remove one or more images from the storage. Remove one or more images from the storage.- Parameters:
images- Images IDs or names to remove. (optional)all- Remove all images. (optional, default to true)force- Force image removal (including containers using the images). (optional)ignore- Ignore if a specified image does not exist and do not throw an error. (optional)lookupManifest- Resolves to manifest list instead of image. (optional)- Returns:
- ApiResponse<LibpodImagesRemoveReport>
- 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 Image Remove - 400 Bad parameter in request - 500 Internal server error -
-
imageDeleteAllLibpodAsync
public okhttp3.Call imageDeleteAllLibpodAsync(List<String> images, Boolean all, Boolean force, Boolean ignore, Boolean lookupManifest, ApiCallback<LibpodImagesRemoveReport> _callback) throws ApiException Remove one or more images from the storage. (asynchronously) Remove one or more images from the storage.- Parameters:
images- Images IDs or names to remove. (optional)all- Remove all images. (optional, default to true)force- Force image removal (including containers using the images). (optional)ignore- Ignore if a specified image does not exist and do not throw an error. (optional)lookupManifest- Resolves to manifest list instead of image. (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 Image Remove - 400 Bad parameter in request - 500 Internal server error -
-
imageDeleteLibpodCall
public okhttp3.Call imageDeleteLibpodCall(String name, Boolean force, ApiCallback _callback) throws ApiException Build call for imageDeleteLibpod- Parameters:
name- name or ID of image to remove (required)force- remove the image even if used by containers or has other tags (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 Image Remove - 400 Bad parameter in request - 404 No such image - 409 Conflict error in operation - 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)force- remove the image even if used by containers or has other tags (optional)- Returns:
- LibpodImagesRemoveReport
- 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 Image Remove - 400 Bad parameter in request - 404 No such image - 409 Conflict error in operation - 500 Internal server error -
-
imageDeleteLibpodWithHttpInfo
public ApiResponse<LibpodImagesRemoveReport> imageDeleteLibpodWithHttpInfo(String name, Boolean force) throws ApiException Remove an image from the local storage. Remove an image from the local storage.- Parameters:
name- name or ID of image to remove (required)force- remove the image even if used by containers or has other tags (optional)- Returns:
- ApiResponse<LibpodImagesRemoveReport>
- 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 Image Remove - 400 Bad parameter in request - 404 No such image - 409 Conflict error in operation - 500 Internal server error -
-
imageDeleteLibpodAsync
public okhttp3.Call imageDeleteLibpodAsync(String name, Boolean force, ApiCallback<LibpodImagesRemoveReport> _callback) throws ApiException Remove an image from the local storage. (asynchronously) Remove an image from the local storage.- Parameters:
name- name or ID of image to remove (required)force- remove the image even if used by containers or has other tags (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 Image Remove - 400 Bad parameter in request - 404 No such image - 409 Conflict error in operation - 500 Internal server error -
-
imageExistsLibpodCall
Build call for imageExistsLibpod- Parameters:
name- the name or ID of the container (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 image exists - 404 No such image - 500 Internal server error -
-
imageExistsLibpod
Image exists Check if image exists in local store- Parameters:
name- the name or ID of the container (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 image exists - 404 No such image - 500 Internal server error -
-
imageExistsLibpodWithHttpInfo
Image exists Check if image exists in local store- Parameters:
name- the name or ID of the container (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 image exists - 404 No such image - 500 Internal server error -
-
imageExistsLibpodAsync
public okhttp3.Call imageExistsLibpodAsync(String name, ApiCallback<Void> _callback) throws ApiException Image exists (asynchronously) Check if image exists in local store- Parameters:
name- the name or ID of the container (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 image exists - 404 No such image - 500 Internal server error -
-
imageExportLibpodCall
public okhttp3.Call imageExportLibpodCall(String format, List<String> references, Boolean compress, Boolean ociAcceptUncompressedLayers, ApiCallback _callback) throws ApiException Build call for imageExportLibpod- Parameters:
format- format for exported image (only docker-archive is supported) (optional)references- references to images to export (optional)compress- use compression on image (optional)ociAcceptUncompressedLayers- accept uncompressed layers when copying OCI images (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 no error - 404 No such image - 500 Internal server error -
-
imageExportLibpod
public File imageExportLibpod(String format, List<String> references, Boolean compress, Boolean ociAcceptUncompressedLayers) throws ApiException Export multiple images Export multiple images into a single object. Only `docker-archive` is currently supported.- Parameters:
format- format for exported image (only docker-archive is supported) (optional)references- references to images to export (optional)compress- use compression on image (optional)ociAcceptUncompressedLayers- accept uncompressed layers when copying OCI images (optional)- Returns:
- File
- 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 no error - 404 No such image - 500 Internal server error -
-
imageExportLibpodWithHttpInfo
public ApiResponse<File> imageExportLibpodWithHttpInfo(String format, List<String> references, Boolean compress, Boolean ociAcceptUncompressedLayers) throws ApiException Export multiple images Export multiple images into a single object. Only `docker-archive` is currently supported.- Parameters:
format- format for exported image (only docker-archive is supported) (optional)references- references to images to export (optional)compress- use compression on image (optional)ociAcceptUncompressedLayers- accept uncompressed layers when copying OCI images (optional)- Returns:
- ApiResponse<File>
- 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 no error - 404 No such image - 500 Internal server error -
-
imageExportLibpodAsync
public okhttp3.Call imageExportLibpodAsync(String format, List<String> references, Boolean compress, Boolean ociAcceptUncompressedLayers, ApiCallback<File> _callback) throws ApiException Export multiple images (asynchronously) Export multiple images into a single object. Only `docker-archive` is currently supported.- Parameters:
format- format for exported image (only docker-archive is supported) (optional)references- references to images to export (optional)compress- use compression on image (optional)ociAcceptUncompressedLayers- accept uncompressed layers when copying OCI images (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 no error - 404 No such image - 500 Internal server error -
-
imageGetLibpodCall
public okhttp3.Call imageGetLibpodCall(String name, String format, Boolean compress, ApiCallback _callback) throws ApiException Build call for imageGetLibpod- Parameters:
name- the name or ID of the container (required)format- format for exported image (optional)compress- use compression on image (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 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)format- format for exported image (optional)compress- use compression on image (optional)- Returns:
- File
- 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 no error - 404 No such image - 500 Internal server error -
-
imageGetLibpodWithHttpInfo
public ApiResponse<File> imageGetLibpodWithHttpInfo(String name, String format, Boolean compress) throws ApiException Export an image Export an image- Parameters:
name- the name or ID of the container (required)format- format for exported image (optional)compress- use compression on image (optional)- Returns:
- ApiResponse<File>
- 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 no error - 404 No such image - 500 Internal server error -
-
imageGetLibpodAsync
public okhttp3.Call imageGetLibpodAsync(String name, String format, Boolean compress, ApiCallback<File> _callback) throws ApiException Export an image (asynchronously) Export an image- Parameters:
name- the name or ID of the container (required)format- format for exported image (optional)compress- use compression on image (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 no error - 404 No such image - 500 Internal server error -
-
imageHistoryLibpodCall
Build call for imageHistoryLibpod- Parameters:
name- the name or ID of the container (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 Image History - 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:
- HistoryResponse
- 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 Image History - 404 No such image - 500 Internal server error -
-
imageHistoryLibpodWithHttpInfo
History of an image Return parent layers of an image.- Parameters:
name- the name or ID of the container (required)- Returns:
- ApiResponse<HistoryResponse>
- 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 Image History - 404 No such image - 500 Internal server error -
-
imageHistoryLibpodAsync
public okhttp3.Call imageHistoryLibpodAsync(String name, ApiCallback<HistoryResponse> _callback) throws ApiException History of an image (asynchronously) Return parent layers of an image.- Parameters:
name- the name or ID of the container (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 Image History - 404 No such image - 500 Internal server error -
-
imageImportLibpodCall
public okhttp3.Call imageImportLibpodCall(File upload, String contentType, List<String> changes, String message, String reference, String url, ApiCallback _callback) throws ApiException Build call for imageImportLibpod- Parameters:
upload- tarball for imported image (required)contentType- (optional, default to application/x-tar)changes- Apply the following possible instructions to the created image: CMD | ENTRYPOINT | ENV | EXPOSE | LABEL | STOPSIGNAL | USER | VOLUME | WORKDIR. JSON encoded string (optional)message- Set commit message for imported image (optional)reference- Optional Name[:TAG] for the image (optional)url- Load image from the specified URL (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 Image Import - 400 Bad parameter in request - 500 Internal server error -
-
imageImportLibpod
public ImageImportReport imageImportLibpod(File upload, String contentType, List<String> changes, String message, String reference, String url) throws ApiException Import image Import a previously exported tarball as an image.- Parameters:
upload- tarball for imported image (required)contentType- (optional, default to application/x-tar)changes- Apply the following possible instructions to the created image: CMD | ENTRYPOINT | ENV | EXPOSE | LABEL | STOPSIGNAL | USER | VOLUME | WORKDIR. JSON encoded string (optional)message- Set commit message for imported image (optional)reference- Optional Name[:TAG] for the image (optional)url- Load image from the specified URL (optional)- Returns:
- ImageImportReport
- 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 Image Import - 400 Bad parameter in request - 500 Internal server error -
-
imageImportLibpodWithHttpInfo
public ApiResponse<ImageImportReport> imageImportLibpodWithHttpInfo(File upload, String contentType, List<String> changes, String message, String reference, String url) throws ApiException Import image Import a previously exported tarball as an image.- Parameters:
upload- tarball for imported image (required)contentType- (optional, default to application/x-tar)changes- Apply the following possible instructions to the created image: CMD | ENTRYPOINT | ENV | EXPOSE | LABEL | STOPSIGNAL | USER | VOLUME | WORKDIR. JSON encoded string (optional)message- Set commit message for imported image (optional)reference- Optional Name[:TAG] for the image (optional)url- Load image from the specified URL (optional)- Returns:
- ApiResponse<ImageImportReport>
- 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 Image Import - 400 Bad parameter in request - 500 Internal server error -
-
imageImportLibpodAsync
public okhttp3.Call imageImportLibpodAsync(File upload, String contentType, List<String> changes, String message, String reference, String url, ApiCallback<ImageImportReport> _callback) throws ApiException Import image (asynchronously) Import a previously exported tarball as an image.- Parameters:
upload- tarball for imported image (required)contentType- (optional, default to application/x-tar)changes- Apply the following possible instructions to the created image: CMD | ENTRYPOINT | ENV | EXPOSE | LABEL | STOPSIGNAL | USER | VOLUME | WORKDIR. JSON encoded string (optional)message- Set commit message for imported image (optional)reference- Optional Name[:TAG] for the image (optional)url- Load image from the specified URL (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 Image Import - 400 Bad parameter in request - 500 Internal server error -
-
imageInspectLibpodCall
Build call for imageInspectLibpod- Parameters:
name- the name or ID of the container (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 Inspect Image - 404 No such image - 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:
- ImageData
- 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 Inspect Image - 404 No such image - 500 Internal server error -
-
imageInspectLibpodWithHttpInfo
Inspect an image Obtain low-level information about an image- Parameters:
name- the name or ID of the container (required)- Returns:
- ApiResponse<ImageData>
- 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 Inspect Image - 404 No such image - 500 Internal server error -
-
imageInspectLibpodAsync
public okhttp3.Call imageInspectLibpodAsync(String name, ApiCallback<ImageData> _callback) throws ApiException Inspect an image (asynchronously) Obtain low-level information about an image- Parameters:
name- the name or ID of the container (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 Inspect Image - 404 No such image - 500 Internal server error -
-
imageListLibpodCall
public okhttp3.Call imageListLibpodCall(Boolean all, String filters, ApiCallback _callback) throws ApiException Build call for imageListLibpod- Parameters:
all- Show all images. Only images from a final layer (no children) are shown by default. (optional, default to false)filters- A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters: - `before`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`) - `dangling=true` - `label=key` or `label=\"key=value\"` of an image label - `reference`=(`<image-name>[:<tag>]`) - `id`=(`<image-id>`) - `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`) (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 Image summary for libpod API - 500 Internal server error -
-
imageListLibpod
List Images Returns a list of images on the server- Parameters:
all- Show all images. Only images from a final layer (no children) are shown by default. (optional, default to false)filters- A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters: - `before`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`) - `dangling=true` - `label=key` or `label=\"key=value\"` of an image label - `reference`=(`<image-name>[:<tag>]`) - `id`=(`<image-id>`) - `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`) (optional)- Returns:
- List<LibpodImageSummary>
- 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 Image summary for libpod API - 500 Internal server error -
-
imageListLibpodWithHttpInfo
public ApiResponse<List<LibpodImageSummary>> imageListLibpodWithHttpInfo(Boolean all, String filters) throws ApiException List Images Returns a list of images on the server- Parameters:
all- Show all images. Only images from a final layer (no children) are shown by default. (optional, default to false)filters- A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters: - `before`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`) - `dangling=true` - `label=key` or `label=\"key=value\"` of an image label - `reference`=(`<image-name>[:<tag>]`) - `id`=(`<image-id>`) - `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`) (optional)- Returns:
- ApiResponse<List<LibpodImageSummary>>
- 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 Image summary for libpod API - 500 Internal server error -
-
imageListLibpodAsync
public okhttp3.Call imageListLibpodAsync(Boolean all, String filters, ApiCallback<List<LibpodImageSummary>> _callback) throws ApiException List Images (asynchronously) Returns a list of images on the server- Parameters:
all- Show all images. Only images from a final layer (no children) are shown by default. (optional, default to false)filters- A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters: - `before`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`) - `dangling=true` - `label=key` or `label=\"key=value\"` of an image label - `reference`=(`<image-name>[:<tag>]`) - `id`=(`<image-id>`) - `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`) (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 Image summary for libpod API - 500 Internal server error -
-
imageLoadLibpodCall
Build call for imageLoadLibpod- Parameters:
upload- tarball of container image (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 Image Load - 400 Bad parameter in request - 500 Internal server error -
-
imageLoadLibpod
Load image Load an image (oci-archive or docker-archive) stream.- Parameters:
upload- tarball of container image (required)- Returns:
- ImageLoadReport
- 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 Image Load - 400 Bad parameter in request - 500 Internal server error -
-
imageLoadLibpodWithHttpInfo
Load image Load an image (oci-archive or docker-archive) stream.- Parameters:
upload- tarball of container image (required)- Returns:
- ApiResponse<ImageLoadReport>
- 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 Image Load - 400 Bad parameter in request - 500 Internal server error -
-
imageLoadLibpodAsync
public okhttp3.Call imageLoadLibpodAsync(String upload, ApiCallback<ImageLoadReport> _callback) throws ApiException Load image (asynchronously) Load an image (oci-archive or docker-archive) stream.- Parameters:
upload- tarball of container image (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 Image Load - 400 Bad parameter in request - 500 Internal server error -
-
imagePruneLibpodCall
public okhttp3.Call imagePruneLibpodCall(Boolean all, Boolean external, Boolean buildcache, String filters, ApiCallback _callback) throws ApiException Build call for imagePruneLibpod- Parameters:
all- Remove all images not in use by containers, not just dangling ones (optional, default to false)external- Remove images even when they are used by external containers (e.g, by build containers) (optional, default to false)buildcache- Remove persistent build cache created by build instructions such as `--mount=type=cache`. (optional, default to false)filters- filters to apply to image pruning, encoded as JSON (map[string][]string). Available filters: - `dangling=<boolean>` When set to `true` (or `1`), prune only unused *and* untagged images. When set to `false` (or `0`), all unused images are pruned. - `until=<string>` Prune images 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 images 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 Image Prune - 500 Internal server error -
-
imagePruneLibpod
public List<PruneReport> imagePruneLibpod(Boolean all, Boolean external, Boolean buildcache, String filters) throws ApiException Prune unused images Remove images that are not being used by a container- Parameters:
all- Remove all images not in use by containers, not just dangling ones (optional, default to false)external- Remove images even when they are used by external containers (e.g, by build containers) (optional, default to false)buildcache- Remove persistent build cache created by build instructions such as `--mount=type=cache`. (optional, default to false)filters- filters to apply to image pruning, encoded as JSON (map[string][]string). Available filters: - `dangling=<boolean>` When set to `true` (or `1`), prune only unused *and* untagged images. When set to `false` (or `0`), all unused images are pruned. - `until=<string>` Prune images 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 images with (or without, in case `label!=...` is used) the specified labels. (optional)- Returns:
- List<PruneReport>
- 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 Image Prune - 500 Internal server error -
-
imagePruneLibpodWithHttpInfo
public ApiResponse<List<PruneReport>> imagePruneLibpodWithHttpInfo(Boolean all, Boolean external, Boolean buildcache, String filters) throws ApiException Prune unused images Remove images that are not being used by a container- Parameters:
all- Remove all images not in use by containers, not just dangling ones (optional, default to false)external- Remove images even when they are used by external containers (e.g, by build containers) (optional, default to false)buildcache- Remove persistent build cache created by build instructions such as `--mount=type=cache`. (optional, default to false)filters- filters to apply to image pruning, encoded as JSON (map[string][]string). Available filters: - `dangling=<boolean>` When set to `true` (or `1`), prune only unused *and* untagged images. When set to `false` (or `0`), all unused images are pruned. - `until=<string>` Prune images 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 images with (or without, in case `label!=...` is used) the specified labels. (optional)- Returns:
- ApiResponse<List<PruneReport>>
- 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 Image Prune - 500 Internal server error -
-
imagePruneLibpodAsync
public okhttp3.Call imagePruneLibpodAsync(Boolean all, Boolean external, Boolean buildcache, String filters, ApiCallback<List<PruneReport>> _callback) throws ApiException Prune unused images (asynchronously) Remove images that are not being used by a container- Parameters:
all- Remove all images not in use by containers, not just dangling ones (optional, default to false)external- Remove images even when they are used by external containers (e.g, by build containers) (optional, default to false)buildcache- Remove persistent build cache created by build instructions such as `--mount=type=cache`. (optional, default to false)filters- filters to apply to image pruning, encoded as JSON (map[string][]string). Available filters: - `dangling=<boolean>` When set to `true` (or `1`), prune only unused *and* untagged images. When set to `false` (or `0`), all unused images are pruned. - `until=<string>` Prune images 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 images 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 Image Prune - 500 Internal server error -
-
imagePullLibpodCall
public okhttp3.Call imagePullLibpodCall(String reference, Boolean quiet, Boolean compatMode, String arch, String OS, String variant, String policy, Boolean tlsVerify, Boolean allTags, String xRegistryAuth, ApiCallback _callback) throws ApiException Build call for imagePullLibpod- Parameters:
reference- Mandatory reference to the image (e.g., quay.io/image/name:tag) (optional)quiet- silences extra stream data on pull (optional, default to false)compatMode- Return the same JSON payload as the Docker-compat endpoint. (optional, default to false)arch- Pull image for the specified architecture. (optional)OS- Pull image for the specified operating system. (optional)variant- Pull image for the specified variant. (optional)policy- Pull policy, \"always\" (default), \"missing\", \"newer\", \"never\". (optional)tlsVerify- Require TLS verification. (optional, default to true)allTags- Pull all tagged images in the repository. (optional)xRegistryAuth- base-64 encoded auth config. Must include the following four values: username, password, email and server address OR simply just an identity token. (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 Image Pull - 400 Bad parameter in request - 500 Internal server error -
-
imagePullLibpod
public LibpodImagesPullReport imagePullLibpod(String reference, Boolean quiet, Boolean compatMode, String arch, String OS, String variant, String policy, Boolean tlsVerify, Boolean allTags, String xRegistryAuth) throws ApiException Pull images Pull one or more images from a container registry.- Parameters:
reference- Mandatory reference to the image (e.g., quay.io/image/name:tag) (optional)quiet- silences extra stream data on pull (optional, default to false)compatMode- Return the same JSON payload as the Docker-compat endpoint. (optional, default to false)arch- Pull image for the specified architecture. (optional)OS- Pull image for the specified operating system. (optional)variant- Pull image for the specified variant. (optional)policy- Pull policy, \"always\" (default), \"missing\", \"newer\", \"never\". (optional)tlsVerify- Require TLS verification. (optional, default to true)allTags- Pull all tagged images in the repository. (optional)xRegistryAuth- base-64 encoded auth config. Must include the following four values: username, password, email and server address OR simply just an identity token. (optional)- Returns:
- LibpodImagesPullReport
- 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 Image Pull - 400 Bad parameter in request - 500 Internal server error -
-
imagePullLibpodWithHttpInfo
public ApiResponse<LibpodImagesPullReport> imagePullLibpodWithHttpInfo(String reference, Boolean quiet, Boolean compatMode, String arch, String OS, String variant, String policy, Boolean tlsVerify, Boolean allTags, String xRegistryAuth) throws ApiException Pull images Pull one or more images from a container registry.- Parameters:
reference- Mandatory reference to the image (e.g., quay.io/image/name:tag) (optional)quiet- silences extra stream data on pull (optional, default to false)compatMode- Return the same JSON payload as the Docker-compat endpoint. (optional, default to false)arch- Pull image for the specified architecture. (optional)OS- Pull image for the specified operating system. (optional)variant- Pull image for the specified variant. (optional)policy- Pull policy, \"always\" (default), \"missing\", \"newer\", \"never\". (optional)tlsVerify- Require TLS verification. (optional, default to true)allTags- Pull all tagged images in the repository. (optional)xRegistryAuth- base-64 encoded auth config. Must include the following four values: username, password, email and server address OR simply just an identity token. (optional)- Returns:
- ApiResponse<LibpodImagesPullReport>
- 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 Image Pull - 400 Bad parameter in request - 500 Internal server error -
-
imagePullLibpodAsync
public okhttp3.Call imagePullLibpodAsync(String reference, Boolean quiet, Boolean compatMode, String arch, String OS, String variant, String policy, Boolean tlsVerify, Boolean allTags, String xRegistryAuth, ApiCallback<LibpodImagesPullReport> _callback) throws ApiException Pull images (asynchronously) Pull one or more images from a container registry.- Parameters:
reference- Mandatory reference to the image (e.g., quay.io/image/name:tag) (optional)quiet- silences extra stream data on pull (optional, default to false)compatMode- Return the same JSON payload as the Docker-compat endpoint. (optional, default to false)arch- Pull image for the specified architecture. (optional)OS- Pull image for the specified operating system. (optional)variant- Pull image for the specified variant. (optional)policy- Pull policy, \"always\" (default), \"missing\", \"newer\", \"never\". (optional)tlsVerify- Require TLS verification. (optional, default to true)allTags- Pull all tagged images in the repository. (optional)xRegistryAuth- base-64 encoded auth config. Must include the following four values: username, password, email and server address OR simply just an identity token. (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 Image Pull - 400 Bad parameter in request - 500 Internal server error -
-
imagePushLibpodCall
public okhttp3.Call imagePushLibpodCall(String name, String destination, Boolean forceCompressionFormat, String compressionFormat, Integer compressionLevel, Boolean tlsVerify, Boolean quiet, String format, Boolean all, Boolean removeSignatures, Integer retry, String retryDelay, String xRegistryAuth, ApiCallback _callback) throws ApiException Build call for imagePushLibpod- Parameters:
name- Name of image to push. (required)destination- Allows for pushing the image to a different destination than the image refers to. (optional)forceCompressionFormat- Enforce compressing the layers with the specified --compression and do not reuse differently compressed blobs on the registry. (optional, default to false)compressionFormat- Compression format used to compress image layers. (optional)compressionLevel- Compression level used to compress image layers. (optional)tlsVerify- Require TLS verification. (optional, default to true)quiet- Silences extra stream data on push. (optional, default to true)format- Manifest type (oci, v2s1, or v2s2) to use when pushing an image. Default is manifest type of source, with fallbacks. (optional)all- All indicates whether to push all images related to the image list. (optional)removeSignatures- Discard any pre-existing signatures in the image. (optional)retry- Number of times to retry push in case of failure. (optional)retryDelay- Delay between retries in case of push failures. Duration format such as \"412ms\", or \"3.5h\". (optional)xRegistryAuth- A base64-encoded auth configuration. (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 no error - 404 No such image - 500 Internal server error -
-
imagePushLibpod
public File imagePushLibpod(String name, String destination, Boolean forceCompressionFormat, String compressionFormat, Integer compressionLevel, Boolean tlsVerify, Boolean quiet, String format, Boolean all, Boolean removeSignatures, Integer retry, String retryDelay, String xRegistryAuth) throws ApiException Push Image Push an image to a container registry- Parameters:
name- Name of image to push. (required)destination- Allows for pushing the image to a different destination than the image refers to. (optional)forceCompressionFormat- Enforce compressing the layers with the specified --compression and do not reuse differently compressed blobs on the registry. (optional, default to false)compressionFormat- Compression format used to compress image layers. (optional)compressionLevel- Compression level used to compress image layers. (optional)tlsVerify- Require TLS verification. (optional, default to true)quiet- Silences extra stream data on push. (optional, default to true)format- Manifest type (oci, v2s1, or v2s2) to use when pushing an image. Default is manifest type of source, with fallbacks. (optional)all- All indicates whether to push all images related to the image list. (optional)removeSignatures- Discard any pre-existing signatures in the image. (optional)retry- Number of times to retry push in case of failure. (optional)retryDelay- Delay between retries in case of push failures. Duration format such as \"412ms\", or \"3.5h\". (optional)xRegistryAuth- A base64-encoded auth configuration. (optional)- Returns:
- File
- 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 no error - 404 No such image - 500 Internal server error -
-
imagePushLibpodWithHttpInfo
public ApiResponse<File> imagePushLibpodWithHttpInfo(String name, String destination, Boolean forceCompressionFormat, String compressionFormat, Integer compressionLevel, Boolean tlsVerify, Boolean quiet, String format, Boolean all, Boolean removeSignatures, Integer retry, String retryDelay, String xRegistryAuth) throws ApiException Push Image Push an image to a container registry- Parameters:
name- Name of image to push. (required)destination- Allows for pushing the image to a different destination than the image refers to. (optional)forceCompressionFormat- Enforce compressing the layers with the specified --compression and do not reuse differently compressed blobs on the registry. (optional, default to false)compressionFormat- Compression format used to compress image layers. (optional)compressionLevel- Compression level used to compress image layers. (optional)tlsVerify- Require TLS verification. (optional, default to true)quiet- Silences extra stream data on push. (optional, default to true)format- Manifest type (oci, v2s1, or v2s2) to use when pushing an image. Default is manifest type of source, with fallbacks. (optional)all- All indicates whether to push all images related to the image list. (optional)removeSignatures- Discard any pre-existing signatures in the image. (optional)retry- Number of times to retry push in case of failure. (optional)retryDelay- Delay between retries in case of push failures. Duration format such as \"412ms\", or \"3.5h\". (optional)xRegistryAuth- A base64-encoded auth configuration. (optional)- Returns:
- ApiResponse<File>
- 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 no error - 404 No such image - 500 Internal server error -
-
imagePushLibpodAsync
public okhttp3.Call imagePushLibpodAsync(String name, String destination, Boolean forceCompressionFormat, String compressionFormat, Integer compressionLevel, Boolean tlsVerify, Boolean quiet, String format, Boolean all, Boolean removeSignatures, Integer retry, String retryDelay, String xRegistryAuth, ApiCallback<File> _callback) throws ApiException Push Image (asynchronously) Push an image to a container registry- Parameters:
name- Name of image to push. (required)destination- Allows for pushing the image to a different destination than the image refers to. (optional)forceCompressionFormat- Enforce compressing the layers with the specified --compression and do not reuse differently compressed blobs on the registry. (optional, default to false)compressionFormat- Compression format used to compress image layers. (optional)compressionLevel- Compression level used to compress image layers. (optional)tlsVerify- Require TLS verification. (optional, default to true)quiet- Silences extra stream data on push. (optional, default to true)format- Manifest type (oci, v2s1, or v2s2) to use when pushing an image. Default is manifest type of source, with fallbacks. (optional)all- All indicates whether to push all images related to the image list. (optional)removeSignatures- Discard any pre-existing signatures in the image. (optional)retry- Number of times to retry push in case of failure. (optional)retryDelay- Delay between retries in case of push failures. Duration format such as \"412ms\", or \"3.5h\". (optional)xRegistryAuth- A base64-encoded auth configuration. (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 no error - 404 No such image - 500 Internal server error -
-
imageResolveLibpodCall
Build call for imageResolveLibpod- Parameters:
name- the (short) name to resolve (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 resolved image names - 400 Bad parameter in request - 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)- 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 resolved image names - 400 Bad parameter in request - 500 Internal server error -
-
imageResolveLibpodWithHttpInfo
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:
- 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 resolved image names - 400 Bad parameter in request - 500 Internal server error -
-
imageResolveLibpodAsync
public okhttp3.Call imageResolveLibpodAsync(String name, ApiCallback<Void> _callback) throws ApiException Resolve an image (short) name (asynchronously) Resolve the passed image name to a list of fully-qualified images referring to container registries.- Parameters:
name- the (short) name to resolve (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 resolved image names - 400 Bad parameter in request - 500 Internal server error -
-
imageScpLibpodCall
public okhttp3.Call imageScpLibpodCall(String name, String destination, Boolean quiet, ApiCallback _callback) throws ApiException Build call for imageScpLibpod- Parameters:
name- source connection/image (required)destination- dest connection/image (optional)quiet- quiet output (optional, default to false)_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 Image Scp - 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)destination- dest connection/image (optional)quiet- quiet output (optional, default to false)- Returns:
- ScpReport
- 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 Image Scp - 400 Bad parameter in request - 500 Internal server error -
-
imageScpLibpodWithHttpInfo
public ApiResponse<ScpReport> imageScpLibpodWithHttpInfo(String name, String destination, Boolean quiet) throws ApiException Copy an image from one host to another Copy an image from one host to another- Parameters:
name- source connection/image (required)destination- dest connection/image (optional)quiet- quiet output (optional, default to false)- Returns:
- ApiResponse<ScpReport>
- 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 Image Scp - 400 Bad parameter in request - 500 Internal server error -
-
imageScpLibpodAsync
public okhttp3.Call imageScpLibpodAsync(String name, String destination, Boolean quiet, ApiCallback<ScpReport> _callback) throws ApiException Copy an image from one host to another (asynchronously) Copy an image from one host to another- Parameters:
name- source connection/image (required)destination- dest connection/image (optional)quiet- quiet output (optional, default to false)_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 Image Scp - 400 Bad parameter in request - 500 Internal server error -
-
imageSearchLibpodCall
public okhttp3.Call imageSearchLibpodCall(String term, Integer limit, String filters, Boolean tlsVerify, Boolean listTags, ApiCallback _callback) throws ApiException Build call for imageSearchLibpod- Parameters:
term- term to search (optional)limit- maximum number of results (optional, default to 25)filters- A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters: - `is-automated=(true|false)` - `is-official=(true|false)` - `stars=<number>` Matches images that have at least 'number' stars. (optional)tlsVerify- Require HTTPS and verify signatures when contacting registries. (optional, default to true)listTags- list the available tags in the repository (optional, default to false)_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 Registry Search - 500 Internal server error -
-
imageSearchLibpod
public ImageSearch200Response imageSearchLibpod(String term, Integer limit, String filters, Boolean tlsVerify, Boolean listTags) throws ApiException Search images Search registries for images- Parameters:
term- term to search (optional)limit- maximum number of results (optional, default to 25)filters- A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters: - `is-automated=(true|false)` - `is-official=(true|false)` - `stars=<number>` Matches images that have at least 'number' stars. (optional)tlsVerify- Require HTTPS and verify signatures when contacting registries. (optional, default to true)listTags- list the available tags in the repository (optional, default to false)- Returns:
- ImageSearch200Response
- 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 Registry Search - 500 Internal server error -
-
imageSearchLibpodWithHttpInfo
public ApiResponse<ImageSearch200Response> imageSearchLibpodWithHttpInfo(String term, Integer limit, String filters, Boolean tlsVerify, Boolean listTags) throws ApiException Search images Search registries for images- Parameters:
term- term to search (optional)limit- maximum number of results (optional, default to 25)filters- A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters: - `is-automated=(true|false)` - `is-official=(true|false)` - `stars=<number>` Matches images that have at least 'number' stars. (optional)tlsVerify- Require HTTPS and verify signatures when contacting registries. (optional, default to true)listTags- list the available tags in the repository (optional, default to false)- Returns:
- ApiResponse<ImageSearch200Response>
- 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 Registry Search - 500 Internal server error -
-
imageSearchLibpodAsync
public okhttp3.Call imageSearchLibpodAsync(String term, Integer limit, String filters, Boolean tlsVerify, Boolean listTags, ApiCallback<ImageSearch200Response> _callback) throws ApiException Search images (asynchronously) Search registries for images- Parameters:
term- term to search (optional)limit- maximum number of results (optional, default to 25)filters- A JSON encoded value of the filters (a `map[string][]string`) to process on the images list. Available filters: - `is-automated=(true|false)` - `is-official=(true|false)` - `stars=<number>` Matches images that have at least 'number' stars. (optional)tlsVerify- Require HTTPS and verify signatures when contacting registries. (optional, default to true)listTags- list the available tags in the repository (optional, default to false)_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 Registry Search - 500 Internal server error -
-
imageTagLibpodCall
public okhttp3.Call imageTagLibpodCall(String name, String repo, String tag, ApiCallback _callback) throws ApiException Build call for imageTagLibpod- Parameters:
name- the name or ID of the container (required)repo- the repository to tag in (optional)tag- the name of the new tag (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 201 no error - 400 Bad parameter in request - 404 No such image - 409 Conflict error in operation - 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)repo- the repository to tag in (optional)tag- the name of the new tag (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 201 no error - 400 Bad parameter in request - 404 No such image - 409 Conflict error in operation - 500 Internal server error -
-
imageTagLibpodWithHttpInfo
public ApiResponse<Void> imageTagLibpodWithHttpInfo(String name, String repo, String tag) throws ApiException Tag an image Tag an image so that it becomes part of a repository.- Parameters:
name- the name or ID of the container (required)repo- the repository to tag in (optional)tag- the name of the new tag (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 201 no error - 400 Bad parameter in request - 404 No such image - 409 Conflict error in operation - 500 Internal server error -
-
imageTagLibpodAsync
public okhttp3.Call imageTagLibpodAsync(String name, String repo, String tag, ApiCallback<Void> _callback) throws ApiException Tag an image (asynchronously) Tag an image so that it becomes part of a repository.- Parameters:
name- the name or ID of the container (required)repo- the repository to tag in (optional)tag- the name of the new tag (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 201 no error - 400 Bad parameter in request - 404 No such image - 409 Conflict error in operation - 500 Internal server error -
-
imageTreeLibpodCall
public okhttp3.Call imageTreeLibpodCall(String name, Boolean whatrequires, ApiCallback _callback) throws ApiException Build call for imageTreeLibpod- Parameters:
name- the name or ID of the container (required)whatrequires- show all child images and layers of the specified image (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 Image Tree - 404 No such image - 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)whatrequires- show all child images and layers of the specified image (optional)- Returns:
- ImageTreeReport
- 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 Image Tree - 404 No such image - 500 Internal server error -
-
imageTreeLibpodWithHttpInfo
public ApiResponse<ImageTreeReport> imageTreeLibpodWithHttpInfo(String name, Boolean whatrequires) throws ApiException Image tree Retrieve the image tree for the provided image name or ID- Parameters:
name- the name or ID of the container (required)whatrequires- show all child images and layers of the specified image (optional)- Returns:
- ApiResponse<ImageTreeReport>
- 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 Image Tree - 404 No such image - 500 Internal server error -
-
imageTreeLibpodAsync
public okhttp3.Call imageTreeLibpodAsync(String name, Boolean whatrequires, ApiCallback<ImageTreeReport> _callback) throws ApiException Image tree (asynchronously) Retrieve the image tree for the provided image name or ID- Parameters:
name- the name or ID of the container (required)whatrequires- show all child images and layers of the specified image (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 Image Tree - 404 No such image - 500 Internal server error -
-
imageUntagLibpodCall
public okhttp3.Call imageUntagLibpodCall(String name, String repo, String tag, ApiCallback _callback) throws ApiException Build call for imageUntagLibpod- Parameters:
name- the name or ID of the container (required)repo- the repository to untag (optional)tag- the name of the tag to untag (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 201 no error - 400 Bad parameter in request - 404 No such image - 409 Conflict error in operation - 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)repo- the repository to untag (optional)tag- the name of the tag to untag (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 201 no error - 400 Bad parameter in request - 404 No such image - 409 Conflict error in operation - 500 Internal server error -
-
imageUntagLibpodWithHttpInfo
public ApiResponse<Void> imageUntagLibpodWithHttpInfo(String name, String repo, String tag) throws ApiException 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)repo- the repository to untag (optional)tag- the name of the tag to untag (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 201 no error - 400 Bad parameter in request - 404 No such image - 409 Conflict error in operation - 500 Internal server error -
-
imageUntagLibpodAsync
public okhttp3.Call imageUntagLibpodAsync(String name, String repo, String tag, ApiCallback<Void> _callback) throws ApiException Untag an image (asynchronously) 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)repo- the repository to untag (optional)tag- the name of the tag to untag (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 201 no error - 400 Bad parameter in request - 404 No such image - 409 Conflict error in operation - 500 Internal server error -
-