Class ImagesCompatApi.APIimageBuildRequest
java.lang.Object
io.github.alersrt.pod4j.openapi.api.ImagesCompatApi.APIimageBuildRequest
- Enclosing class:
- ImagesCompatApi
-
Method Summary
Modifier and TypeMethodDescriptionSet buildargsokhttp3.CallbuildCall(ApiCallback _callback) Build call for imageBuildSet cachefromcompatvolumes(Boolean compatvolumes) Set compatvolumescontentType(String contentType) Set contentTypeSet cpuperiodSet cpuquotacpusetcpus(String cpusetcpus) Set cpusetcpusSet cpusharesdockerfile(String dockerfile) Set dockerfileexecute()Execute imageBuild requestokhttp3.CallexecuteAsync(ApiCallback<ImageBuild200Response> _callback) Execute imageBuild request (asynchronously)Execute imageBuild request with HTTP info returnedextrahosts(String extrahosts) Set extrahostsSet forcerminputStream(File inputStream) Set inputStreamSet labelsSet memorySet memswapnetworkmode(String networkmode) Set networkmodeSet nocacheSet nohostsSet outputsSet platformSet pullSet qSet remoteSet retryretryDelay(String retryDelay) Set retryDelaySet rmSet shmsizeSet squashSet tSet targetxRegistryConfig(String xRegistryConfig) Set xRegistryConfig
-
Method Details
-
contentType
Set contentType- Parameters:
contentType- (optional, default to application/x-tar)- Returns:
- APIimageBuildRequest
-
xRegistryConfig
Set xRegistryConfig- Parameters:
xRegistryConfig- (optional)- Returns:
- APIimageBuildRequest
-
dockerfile
Set dockerfile- 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)- Returns:
- APIimageBuildRequest
-
t
Set t- Parameters:
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)- Returns:
- APIimageBuildRequest
-
extrahosts
Set extrahosts- Parameters:
extrahosts- TBD Extra hosts to add to /etc/hosts (As of version 1.xx) (optional)- Returns:
- APIimageBuildRequest
-
nohosts
Set nohosts- Parameters:
nohosts- Not to create /etc/hosts when building the image (optional)- Returns:
- APIimageBuildRequest
-
remote
Set remote- Parameters:
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)- Returns:
- APIimageBuildRequest
-
retry
Set retry- Parameters:
retry- Number of times to retry in case of failure when performing push/pull. (optional, default to 3)- Returns:
- APIimageBuildRequest
-
retryDelay
Set retryDelay- Parameters:
retryDelay- Delay between retries in case of push/pull failures. (optional, default to 2s)- Returns:
- APIimageBuildRequest
-
q
Set q- Parameters:
q- Suppress verbose build output (optional, default to false)- Returns:
- APIimageBuildRequest
-
compatvolumes
Set compatvolumes- Parameters:
compatvolumes- Contents of base images to be modified on ADD or COPY only (As of Podman version v5.2) (optional, default to false)- Returns:
- APIimageBuildRequest
-
nocache
Set nocache- Parameters:
nocache- Do not use the cache when building the image (As of version 1.xx) (optional, default to false)- Returns:
- APIimageBuildRequest
-
cachefrom
Set cachefrom- Parameters:
cachefrom- JSON array of images used to build cache resolution (As of version 1.xx) (optional)- Returns:
- APIimageBuildRequest
-
pull
Set pull- Parameters:
pull- Attempt to pull the image even if an older image exists locally (As of version 1.xx) (optional, default to false)- Returns:
- APIimageBuildRequest
-
rm
Set rm- Parameters:
rm- Remove intermediate containers after a successful build (As of version 1.xx) (optional, default to true)- Returns:
- APIimageBuildRequest
-
forcerm
Set forcerm- Parameters:
forcerm- Always remove intermediate containers, even upon failure (As of version 1.xx) (optional, default to false)- Returns:
- APIimageBuildRequest
-
memory
Set memory- Parameters:
memory- Memory is the upper limit (in bytes) on how much memory running containers can use (As of version 1.xx) (optional)- Returns:
- APIimageBuildRequest
-
memswap
Set memswap- Parameters:
memswap- MemorySwap limits the amount of memory and swap together (As of version 1.xx) (optional)- Returns:
- APIimageBuildRequest
-
cpusetcpus
Set cpusetcpus- Parameters:
cpusetcpus- CPUSetCPUs in which to allow execution (0-3, 0,1) (As of version 1.xx) (optional)- Returns:
- APIimageBuildRequest
-
cpuperiod
Set cpuperiod- Parameters:
cpuperiod- CPUPeriod limits the CPU CFS (Completely Fair Scheduler) period (As of version 1.xx) (optional)- Returns:
- APIimageBuildRequest
-
cpuquota
Set cpuquota- Parameters:
cpuquota- CPUQuota limits the CPU CFS (Completely Fair Scheduler) quota (As of version 1.xx) (optional)- Returns:
- APIimageBuildRequest
-
buildargs
Set buildargs- Parameters:
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)- Returns:
- APIimageBuildRequest
-
shmsize
Set shmsize- Parameters:
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)- Returns:
- APIimageBuildRequest
-
squash
Set squash- Parameters:
squash- Silently ignored. Squash the resulting images layers into a single layer (As of version 1.xx) (optional, default to false)- Returns:
- APIimageBuildRequest
-
labels
Set labels- Parameters:
labels- JSON map of key, value pairs to set as labels on the new image (As of version 1.xx) (optional)- Returns:
- APIimageBuildRequest
-
networkmode
Set networkmode- Parameters:
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)- Returns:
- APIimageBuildRequest
-
platform
Set platform- Parameters:
platform- Platform format os[/arch[/variant]] Can be comma separated list for multi arch builds. (As of version 1.xx) (optional)- Returns:
- APIimageBuildRequest
-
target
Set target- Parameters:
target- Target build stage (As of version 1.xx) (optional)- Returns:
- APIimageBuildRequest
-
outputs
Set outputs- Parameters:
outputs- output configuration TBD (As of version 1.xx) (optional)- Returns:
- APIimageBuildRequest
-
inputStream
Set inputStream- Parameters:
inputStream- A tar archive compressed with one of the following algorithms: identity (no compression), gzip, bzip2, xz. (optional)- Returns:
- APIimageBuildRequest
-
buildCall
Build call for imageBuild- Parameters:
_callback- ApiCallback API callback- 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 -
-
execute
Execute imageBuild request- 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 -
-
executeWithHttpInfo
Execute imageBuild request with HTTP info returned- 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 -
-
executeAsync
Execute imageBuild request (asynchronously)- Parameters:
_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 -
-