Class ImagesCompatApi
java.lang.Object
io.github.alersrt.pod4j.openapi.api.ImagesCompatApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintimageBuild(String contentType, String xRegistryConfig, String dockerfile, String t, String extrahosts, String remote, Integer retry, String retryDelay, 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, String networkmode, String platform, String target, String outputs, File inputStream) Create image Build an image from the given Dockerfile(s)okhttp3.CallimageBuildAsync(String contentType, String xRegistryConfig, String dockerfile, String t, String extrahosts, String remote, Integer retry, String retryDelay, 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, String networkmode, String platform, String target, String outputs, File inputStream, ApiCallback<ImageBuild200Response> _callback) Create image (asynchronously) Build an image from the given Dockerfile(s)okhttp3.CallimageBuildCall(String contentType, String xRegistryConfig, String dockerfile, String t, String extrahosts, String remote, Integer retry, String retryDelay, 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, String networkmode, String platform, String target, String outputs, File inputStream, ApiCallback _callback) Build call for imageBuildimageBuildWithHttpInfo(String contentType, String xRegistryConfig, String dockerfile, String t, String extrahosts, String remote, Integer retry, String retryDelay, 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, String networkmode, String platform, String target, String outputs, File inputStream) Create image Build an image from the given Dockerfile(s)imageCreate(String xRegistryAuth, String fromImage, String fromSrc, String repo, String tag, String message, String platform, File inputImage) Create an image Create an image by either pulling it from a registry or importing it.okhttp3.CallimageCreateAsync(String xRegistryAuth, String fromImage, String fromSrc, String repo, String tag, String message, String platform, File inputImage, ApiCallback<File> _callback) Create an image (asynchronously) Create an image by either pulling it from a registry or importing it.okhttp3.CallimageCreateCall(String xRegistryAuth, String fromImage, String fromSrc, String repo, String tag, String message, String platform, File inputImage, ApiCallback _callback) Build call for imageCreateimageCreateWithHttpInfo(String xRegistryAuth, String fromImage, String fromSrc, String repo, String tag, String message, String platform, File inputImage) Create an image Create an image by either pulling it from a registry or importing it.imageDelete(String name, Boolean force, Boolean noprune) Remove Image Delete an image from local storageokhttp3.CallimageDeleteAsync(String name, Boolean force, Boolean noprune, ApiCallback<List<ImageDelete200ResponseInner>> _callback) Remove Image (asynchronously) Delete an image from local storageokhttp3.CallimageDeleteCall(String name, Boolean force, Boolean noprune, ApiCallback _callback) Build call for imageDeleteimageDeleteWithHttpInfo(@NotNull String name, Boolean force, Boolean noprune) Remove Image Delete an image from local storageExport an image Export an image in tarball formatimageGetAll(String names) Export several images Get a tarball containing all images and metadata for several image repositoriesokhttp3.CallimageGetAllAsync(String names, ApiCallback<File> _callback) Export several images (asynchronously) Get a tarball containing all images and metadata for several image repositoriesokhttp3.CallimageGetAllCall(String names, ApiCallback _callback) Build call for imageGetAllimageGetAllWithHttpInfo(@NotNull String names) Export several images Get a tarball containing all images and metadata for several image repositoriesokhttp3.CallimageGetAsync(String name, ApiCallback<File> _callback) Export an image (asynchronously) Export an image in tarball formatokhttp3.CallimageGetCall(String name, ApiCallback _callback) Build call for imageGetimageGetWithHttpInfo(@NotNull String name) Export an image Export an image in tarball formatimageHistory(String name) History of an image Return parent layers of an image.okhttp3.CallimageHistoryAsync(String name, ApiCallback<HistoryResponse> _callback) History of an image (asynchronously) Return parent layers of an image.okhttp3.CallimageHistoryCall(String name, ApiCallback _callback) Build call for imageHistoryimageHistoryWithHttpInfo(@NotNull String name) History of an image Return parent layers of an image.imageInspect(String name) Inspect an image Return low-level information about an image.okhttp3.CallimageInspectAsync(String name, ApiCallback<ImageInspect> _callback) Inspect an image (asynchronously) Return low-level information about an image.okhttp3.CallimageInspectCall(String name, ApiCallback _callback) Build call for imageInspectimageInspectWithHttpInfo(@NotNull String name) Inspect an image Return low-level information about an image.List Images Returns a list of images on the server.okhttp3.CallimageListAsync(Boolean all, String filters, Boolean digests, ApiCallback<List<Summary>> _callback) List Images (asynchronously) Returns a list of images on the server.okhttp3.CallimageListCall(Boolean all, String filters, Boolean digests, ApiCallback _callback) Build call for imageListimageListWithHttpInfo(Boolean all, String filters, Boolean digests) List Images Returns a list of images on the server.voidImport image Load a set of images and tags into a repository.okhttp3.CallimageLoadAsync(Boolean quiet, String request, ApiCallback<Void> _callback) Import image (asynchronously) Load a set of images and tags into a repository.okhttp3.CallimageLoadCall(Boolean quiet, String request, ApiCallback _callback) Build call for imageLoadimageLoadWithHttpInfo(Boolean quiet, String request) Import image Load a set of images and tags into a repository.imagePrune(String filters) Prune unused images Remove images from local storage that are not being used by a containerokhttp3.CallimagePruneAsync(String filters, ApiCallback<List<ImageDelete200ResponseInner>> _callback) Prune unused images (asynchronously) Remove images from local storage that are not being used by a containerokhttp3.CallimagePruneCall(String filters, ApiCallback _callback) Build call for imagePruneimagePruneWithHttpInfo(String filters) Prune unused images Remove images from local storage that are not being used by a containerimagePush(String name, String tag, Boolean all, Boolean compress, String destination, String format, Boolean tlsVerify, String xRegistryAuth) Push Image Push an image to a container registryokhttp3.CallimagePushAsync(String name, String tag, Boolean all, Boolean compress, String destination, String format, Boolean tlsVerify, String xRegistryAuth, ApiCallback<File> _callback) Push Image (asynchronously) Push an image to a container registryokhttp3.CallimagePushCall(String name, String tag, Boolean all, Boolean compress, String destination, String format, Boolean tlsVerify, String xRegistryAuth, ApiCallback _callback) Build call for imagePushimagePushWithHttpInfo(@NotNull String name, String tag, Boolean all, Boolean compress, String destination, String format, Boolean tlsVerify, String xRegistryAuth) Push Image Push an image to a container registrySearch images Search registries for an imageokhttp3.CallimageSearchAsync(String term, Integer limit, String filters, Boolean tlsVerify, Boolean listTags, ApiCallback<ImageSearch200Response> _callback) Search images (asynchronously) Search registries for an imageokhttp3.CallimageSearchCall(String term, Integer limit, String filters, Boolean tlsVerify, Boolean listTags, ApiCallback _callback) Build call for imageSearchimageSearchWithHttpInfo(String term, Integer limit, String filters, Boolean tlsVerify, Boolean listTags) Search images Search registries for an imagevoidTag an image Tag an image so that it becomes part of a repository.okhttp3.CallimageTagAsync(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.CallimageTagCall(String name, String repo, String tag, ApiCallback _callback) Build call for imageTagimageTagWithHttpInfo(@NotNull String name, String repo, String tag) Tag an image Tag an image so that it becomes part of a repository.voidsetApiClient(ApiClient apiClient) voidsetCustomBaseUrl(String customBaseUrl) voidsetHostIndex(int hostIndex)
-
Constructor Details
-
ImagesCompatApi
public ImagesCompatApi() -
ImagesCompatApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
getHostIndex
public int getHostIndex() -
setHostIndex
public void setHostIndex(int hostIndex) -
getCustomBaseUrl
-
setCustomBaseUrl
-
imageBuildCall
public okhttp3.Call imageBuildCall(String contentType, String xRegistryConfig, String dockerfile, String t, String extrahosts, String remote, Integer retry, String retryDelay, 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, String networkmode, String platform, String target, String outputs, File inputStream, ApiCallback _callback) throws ApiException Build call for imageBuild- Parameters:
contentType- (optional, default to application/x-tar)xRegistryConfig- (optional)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)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)retry- Number of times to retry in case of failure when performing push/pull. (optional, default to 3)retryDelay- Delay between retries in case of push/pull failures. (optional, default to 2s)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)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]] Can be comma separated list for multi arch builds. (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)inputStream- A tar archive compressed with one of the following algorithms: identity (no compression), gzip, bzip2, xz. (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 -
-
imageBuild
public ImageBuild200Response imageBuild(String contentType, String xRegistryConfig, String dockerfile, String t, String extrahosts, String remote, Integer retry, String retryDelay, 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, String networkmode, String platform, String target, String outputs, File inputStream) throws ApiException Create image Build an image from the given Dockerfile(s)- Parameters:
contentType- (optional, default to application/x-tar)xRegistryConfig- (optional)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)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)retry- Number of times to retry in case of failure when performing push/pull. (optional, default to 3)retryDelay- Delay between retries in case of push/pull failures. (optional, default to 2s)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)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]] Can be comma separated list for multi arch builds. (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)inputStream- A tar archive compressed with one of the following algorithms: identity (no compression), gzip, bzip2, xz. (optional)- Returns:
- ImageBuild200Response
- 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 -
-
imageBuildWithHttpInfo
public ApiResponse<ImageBuild200Response> imageBuildWithHttpInfo(String contentType, String xRegistryConfig, String dockerfile, String t, String extrahosts, String remote, Integer retry, String retryDelay, 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, String networkmode, String platform, String target, String outputs, File inputStream) throws ApiException Create image Build an image from the given Dockerfile(s)- Parameters:
contentType- (optional, default to application/x-tar)xRegistryConfig- (optional)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)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)retry- Number of times to retry in case of failure when performing push/pull. (optional, default to 3)retryDelay- Delay between retries in case of push/pull failures. (optional, default to 2s)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)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]] Can be comma separated list for multi arch builds. (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)inputStream- A tar archive compressed with one of the following algorithms: identity (no compression), gzip, bzip2, xz. (optional)- Returns:
- ApiResponse<ImageBuild200Response>
- 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 -
-
imageBuildAsync
public okhttp3.Call imageBuildAsync(String contentType, String xRegistryConfig, String dockerfile, String t, String extrahosts, String remote, Integer retry, String retryDelay, 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, String networkmode, String platform, String target, String outputs, File inputStream, ApiCallback<ImageBuild200Response> _callback) throws ApiException Create image (asynchronously) Build an image from the given Dockerfile(s)- Parameters:
contentType- (optional, default to application/x-tar)xRegistryConfig- (optional)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)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)retry- Number of times to retry in case of failure when performing push/pull. (optional, default to 3)retryDelay- Delay between retries in case of push/pull failures. (optional, default to 2s)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)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]] Can be comma separated list for multi arch builds. (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)inputStream- A tar archive compressed with one of the following algorithms: identity (no compression), gzip, bzip2, xz. (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 -
-
imageCreateCall
public okhttp3.Call imageCreateCall(String xRegistryAuth, String fromImage, String fromSrc, String repo, String tag, String message, String platform, File inputImage, ApiCallback _callback) throws ApiException Build call for imageCreate- Parameters:
xRegistryAuth- A base64-encoded auth configuration. (optional)fromImage- Name of the image to pull. The name may include a tag or digest. This parameter may only be used when pulling an image. The pull is cancelled if the HTTP connection is closed. (optional)fromSrc- Source to import. The value may be a URL from which the image can be retrieved or - to read the image from the request body. This parameter may only be used when importing an image (optional)repo- Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image. (optional)tag- Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled. (optional)message- Set commit message for imported image. (optional)platform- Platform in the format os[/arch[/variant]] (optional)inputImage- Image content if fromSrc parameter was used (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 -
-
imageCreate
public File imageCreate(String xRegistryAuth, String fromImage, String fromSrc, String repo, String tag, String message, String platform, File inputImage) throws ApiException Create an image Create an image by either pulling it from a registry or importing it.- Parameters:
xRegistryAuth- A base64-encoded auth configuration. (optional)fromImage- Name of the image to pull. The name may include a tag or digest. This parameter may only be used when pulling an image. The pull is cancelled if the HTTP connection is closed. (optional)fromSrc- Source to import. The value may be a URL from which the image can be retrieved or - to read the image from the request body. This parameter may only be used when importing an image (optional)repo- Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image. (optional)tag- Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled. (optional)message- Set commit message for imported image. (optional)platform- Platform in the format os[/arch[/variant]] (optional)inputImage- Image content if fromSrc parameter was used (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 -
-
imageCreateWithHttpInfo
public ApiResponse<File> imageCreateWithHttpInfo(String xRegistryAuth, String fromImage, String fromSrc, String repo, String tag, String message, String platform, File inputImage) throws ApiException Create an image Create an image by either pulling it from a registry or importing it.- Parameters:
xRegistryAuth- A base64-encoded auth configuration. (optional)fromImage- Name of the image to pull. The name may include a tag or digest. This parameter may only be used when pulling an image. The pull is cancelled if the HTTP connection is closed. (optional)fromSrc- Source to import. The value may be a URL from which the image can be retrieved or - to read the image from the request body. This parameter may only be used when importing an image (optional)repo- Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image. (optional)tag- Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled. (optional)message- Set commit message for imported image. (optional)platform- Platform in the format os[/arch[/variant]] (optional)inputImage- Image content if fromSrc parameter was used (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 -
-
imageCreateAsync
public okhttp3.Call imageCreateAsync(String xRegistryAuth, String fromImage, String fromSrc, String repo, String tag, String message, String platform, File inputImage, ApiCallback<File> _callback) throws ApiException Create an image (asynchronously) Create an image by either pulling it from a registry or importing it.- Parameters:
xRegistryAuth- A base64-encoded auth configuration. (optional)fromImage- Name of the image to pull. The name may include a tag or digest. This parameter may only be used when pulling an image. The pull is cancelled if the HTTP connection is closed. (optional)fromSrc- Source to import. The value may be a URL from which the image can be retrieved or - to read the image from the request body. This parameter may only be used when importing an image (optional)repo- Repository name given to an image when it is imported. The repo may include a tag. This parameter may only be used when importing an image. (optional)tag- Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled. (optional)message- Set commit message for imported image. (optional)platform- Platform in the format os[/arch[/variant]] (optional)inputImage- Image content if fromSrc parameter was used (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 -
-
imageDeleteCall
public okhttp3.Call imageDeleteCall(String name, Boolean force, Boolean noprune, ApiCallback _callback) throws ApiException Build call for imageDelete- Parameters:
name- name or ID of image to delete (required)force- remove the image even if used by containers or has other tags (optional)noprune- do not remove dangling parent 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 Image Delete - 404 No such image - 409 Conflict error in operation - 500 Internal server error -
-
imageDelete
public List<ImageDelete200ResponseInner> imageDelete(String name, Boolean force, Boolean noprune) throws ApiException Remove Image Delete an image from local storage- Parameters:
name- name or ID of image to delete (required)force- remove the image even if used by containers or has other tags (optional)noprune- do not remove dangling parent images (optional)- Returns:
- List<ImageDelete200ResponseInner>
- 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 Delete - 404 No such image - 409 Conflict error in operation - 500 Internal server error -
-
imageDeleteWithHttpInfo
public ApiResponse<List<ImageDelete200ResponseInner>> imageDeleteWithHttpInfo(@NotNull @NotNull String name, Boolean force, Boolean noprune) throws ApiException Remove Image Delete an image from local storage- Parameters:
name- name or ID of image to delete (required)force- remove the image even if used by containers or has other tags (optional)noprune- do not remove dangling parent images (optional)- Returns:
- ApiResponse<List<ImageDelete200ResponseInner>>
- 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 Delete - 404 No such image - 409 Conflict error in operation - 500 Internal server error -
-
imageDeleteAsync
public okhttp3.Call imageDeleteAsync(String name, Boolean force, Boolean noprune, ApiCallback<List<ImageDelete200ResponseInner>> _callback) throws ApiException Remove Image (asynchronously) Delete an image from local storage- Parameters:
name- name or ID of image to delete (required)force- remove the image even if used by containers or has other tags (optional)noprune- do not remove dangling parent 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 Image Delete - 404 No such image - 409 Conflict error in operation - 500 Internal server error -
-
imageGetCall
Build call for imageGet- 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 no error - 500 Internal server error -
-
imageGet
Export an image Export an image in tarball format- Parameters:
name- the name or ID of the container (required)- 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 - 500 Internal server error -
-
imageGetWithHttpInfo
Export an image Export an image in tarball format- Parameters:
name- the name or ID of the container (required)- 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 - 500 Internal server error -
-
imageGetAsync
Export an image (asynchronously) Export an image in tarball format- 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 no error - 500 Internal server error -
-
imageGetAllCall
Build call for imageGetAll- Parameters:
names- one or more image names or IDs comma separated (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 no error - 500 Internal server error -
-
imageGetAll
Export several images Get a tarball containing all images and metadata for several image repositories- Parameters:
names- one or more image names or IDs comma separated (required)- Returns:
- 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 - 500 Internal server error -
-
imageGetAllWithHttpInfo
public ApiResponse<File> imageGetAllWithHttpInfo(@NotNull @NotNull String names) throws ApiException Export several images Get a tarball containing all images and metadata for several image repositories- Parameters:
names- one or more image names or IDs comma separated (required)- Returns:
- 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 - 500 Internal server error -
-
imageGetAllAsync
Export several images (asynchronously) Get a tarball containing all images and metadata for several image repositories- Parameters:
names- one or more image names or IDs comma separated (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 no error - 500 Internal server error -
-
imageHistoryCall
Build call for imageHistory- 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 -
-
imageHistory
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 -
-
imageHistoryWithHttpInfo
public ApiResponse<HistoryResponse> imageHistoryWithHttpInfo(@NotNull @NotNull String name) throws ApiException 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 -
-
imageHistoryAsync
public okhttp3.Call imageHistoryAsync(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 -
-
imageInspectCall
Build call for imageInspect- 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 Inspect - 404 No such image - 500 Internal server error -
-
imageInspect
Inspect an image Return low-level information about an image.- Parameters:
name- the name or ID of the container (required)- Returns:
- ImageInspect
- 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 Inspect - 404 No such image - 500 Internal server error -
-
imageInspectWithHttpInfo
public ApiResponse<ImageInspect> imageInspectWithHttpInfo(@NotNull @NotNull String name) throws ApiException Inspect an image Return low-level information about an image.- Parameters:
name- the name or ID of the container (required)- Returns:
- ApiResponse<ImageInspect>
- 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 Inspect - 404 No such image - 500 Internal server error -
-
imageInspectAsync
public okhttp3.Call imageInspectAsync(String name, ApiCallback<ImageInspect> _callback) throws ApiException Inspect an image (asynchronously) Return 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 Image Inspect - 404 No such image - 500 Internal server error -
-
imageListCall
public okhttp3.Call imageListCall(Boolean all, String filters, Boolean digests, ApiCallback _callback) throws ApiException Build call for imageList- 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>]`) - `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`) (optional)digests- Not supported (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 summary for compat API - 500 Internal server error -
-
imageList
List Images Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image.- 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>]`) - `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`) (optional)digests- Not supported (optional, default to false)- Returns:
- List<Summary>
- 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 compat API - 500 Internal server error -
-
imageListWithHttpInfo
public ApiResponse<List<Summary>> imageListWithHttpInfo(Boolean all, String filters, Boolean digests) throws ApiException List Images Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image.- 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>]`) - `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`) (optional)digests- Not supported (optional, default to false)- Returns:
- ApiResponse<List<Summary>>
- 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 compat API - 500 Internal server error -
-
imageListAsync
public okhttp3.Call imageListAsync(Boolean all, String filters, Boolean digests, ApiCallback<List<Summary>> _callback) throws ApiException List Images (asynchronously) Returns a list of images on the server. Note that it uses a different, smaller representation of an image than inspecting a single image.- 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>]`) - `since`=(`<image-name>[:<tag>]`, `<image id>` or `<image@digest>`) (optional)digests- Not supported (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 summary for compat API - 500 Internal server error -
-
imageLoadCall
public okhttp3.Call imageLoadCall(Boolean quiet, String request, ApiCallback _callback) throws ApiException Build call for imageLoad- Parameters:
quiet- not supported (optional)request- tarball of container 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 - 500 Internal server error -
-
imageLoad
Import image Load a set of images and tags into a repository.- Parameters:
quiet- not supported (optional)request- tarball of container image (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 no error - 500 Internal server error -
-
imageLoadWithHttpInfo
Import image Load a set of images and tags into a repository.- Parameters:
quiet- not supported (optional)request- tarball of container image (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 no error - 500 Internal server error -
-
imageLoadAsync
public okhttp3.Call imageLoadAsync(Boolean quiet, String request, ApiCallback<Void> _callback) throws ApiException Import image (asynchronously) Load a set of images and tags into a repository.- Parameters:
quiet- not supported (optional)request- tarball of container 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 - 500 Internal server error -
-
imagePruneCall
Build call for imagePrune- Parameters:
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 Delete - 500 Internal server error -
-
imagePrune
Prune unused images Remove images from local storage that are not being used by a container- Parameters:
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<ImageDelete200ResponseInner>
- 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 Delete - 500 Internal server error -
-
imagePruneWithHttpInfo
public ApiResponse<List<ImageDelete200ResponseInner>> imagePruneWithHttpInfo(String filters) throws ApiException Prune unused images Remove images from local storage that are not being used by a container- Parameters:
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<ImageDelete200ResponseInner>>
- 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 Delete - 500 Internal server error -
-
imagePruneAsync
public okhttp3.Call imagePruneAsync(String filters, ApiCallback<List<ImageDelete200ResponseInner>> _callback) throws ApiException Prune unused images (asynchronously) Remove images from local storage that are not being used by a container- Parameters:
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 Delete - 500 Internal server error -
-
imagePushCall
public okhttp3.Call imagePushCall(String name, String tag, Boolean all, Boolean compress, String destination, String format, Boolean tlsVerify, String xRegistryAuth, ApiCallback _callback) throws ApiException Build call for imagePush- Parameters:
name- Name of image to push. (required)tag- The tag to associate with the image on the registry. (optional)all- All indicates whether to push all images related to the image list (optional)compress- Use compression on image. (optional)destination- Allows for pushing the image to a different destination than the image refers to. (optional)format- Manifest type (oci, v2s1, or v2s2) to use when pushing an image. Default is manifest type of source, with fallbacks. (optional)tlsVerify- Require TLS verification. (optional, default to true)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 -
-
imagePush
public File imagePush(String name, String tag, Boolean all, Boolean compress, String destination, String format, Boolean tlsVerify, String xRegistryAuth) throws ApiException Push Image Push an image to a container registry- Parameters:
name- Name of image to push. (required)tag- The tag to associate with the image on the registry. (optional)all- All indicates whether to push all images related to the image list (optional)compress- Use compression on image. (optional)destination- Allows for pushing the image to a different destination than the image refers to. (optional)format- Manifest type (oci, v2s1, or v2s2) to use when pushing an image. Default is manifest type of source, with fallbacks. (optional)tlsVerify- Require TLS verification. (optional, default to true)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 -
-
imagePushWithHttpInfo
public ApiResponse<File> imagePushWithHttpInfo(@NotNull @NotNull String name, String tag, Boolean all, Boolean compress, String destination, String format, Boolean tlsVerify, String xRegistryAuth) throws ApiException Push Image Push an image to a container registry- Parameters:
name- Name of image to push. (required)tag- The tag to associate with the image on the registry. (optional)all- All indicates whether to push all images related to the image list (optional)compress- Use compression on image. (optional)destination- Allows for pushing the image to a different destination than the image refers to. (optional)format- Manifest type (oci, v2s1, or v2s2) to use when pushing an image. Default is manifest type of source, with fallbacks. (optional)tlsVerify- Require TLS verification. (optional, default to true)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 -
-
imagePushAsync
public okhttp3.Call imagePushAsync(String name, String tag, Boolean all, Boolean compress, String destination, String format, Boolean tlsVerify, 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)tag- The tag to associate with the image on the registry. (optional)all- All indicates whether to push all images related to the image list (optional)compress- Use compression on image. (optional)destination- Allows for pushing the image to a different destination than the image refers to. (optional)format- Manifest type (oci, v2s1, or v2s2) to use when pushing an image. Default is manifest type of source, with fallbacks. (optional)tlsVerify- Require TLS verification. (optional, default to true)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 -
-
imageSearchCall
public okhttp3.Call imageSearchCall(String term, Integer limit, String filters, Boolean tlsVerify, Boolean listTags, ApiCallback _callback) throws ApiException Build call for imageSearch- 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)_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 - 400 Bad parameter in request - 500 Internal server error -
-
imageSearch
public ImageSearch200Response imageSearch(String term, Integer limit, String filters, Boolean tlsVerify, Boolean listTags) throws ApiException Search images Search registries for an image- 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)- 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 - 400 Bad parameter in request - 500 Internal server error -
-
imageSearchWithHttpInfo
public ApiResponse<ImageSearch200Response> imageSearchWithHttpInfo(String term, Integer limit, String filters, Boolean tlsVerify, Boolean listTags) throws ApiException Search images Search registries for an image- 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)- 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 - 400 Bad parameter in request - 500 Internal server error -
-
imageSearchAsync
public okhttp3.Call imageSearchAsync(String term, Integer limit, String filters, Boolean tlsVerify, Boolean listTags, ApiCallback<ImageSearch200Response> _callback) throws ApiException Search images (asynchronously) Search registries for an image- 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)_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 - 400 Bad parameter in request - 500 Internal server error -
-
imageTagCall
public okhttp3.Call imageTagCall(String name, String repo, String tag, ApiCallback _callback) throws ApiException Build call for imageTag- 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 -
-
imageTag
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 -
-
imageTagWithHttpInfo
public ApiResponse<Void> imageTagWithHttpInfo(@NotNull @NotNull 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 -
-
imageTagAsync
public okhttp3.Call imageTagAsync(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 -
-