Package io.github.alersrt.pod4j.openapi.api

Class ImagesCompatApi.APIimageCreateRequest

java.lang.Object
io.github.alersrt.pod4j.openapi.api.ImagesCompatApi.APIimageCreateRequest
Enclosing class:
ImagesCompatApi
public class ImagesCompatApi.APIimageCreateRequest extends Object

  • Method Details

    • xRegistryAuth

      public ImagesCompatApi.APIimageCreateRequest xRegistryAuth(String xRegistryAuth)
      Set xRegistryAuth
      Parameters:
      xRegistryAuth - A base64-encoded auth configuration. (optional)
      Returns:
      APIimageCreateRequest

    • fromImage

      public ImagesCompatApi.APIimageCreateRequest fromImage(String fromImage)
      Set fromImage
      Parameters:
      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)
      Returns:
      APIimageCreateRequest

    • fromSrc

      public ImagesCompatApi.APIimageCreateRequest fromSrc(String fromSrc)
      Set fromSrc
      Parameters:
      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)
      Returns:
      APIimageCreateRequest

    • repo

      public ImagesCompatApi.APIimageCreateRequest repo(String repo)
      Set repo
      Parameters:
      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)
      Returns:
      APIimageCreateRequest

    • tag

      public ImagesCompatApi.APIimageCreateRequest tag(String tag)
      Set tag
      Parameters:
      tag - Tag or digest. If empty when pulling an image, this causes all tags for the given image to be pulled. (optional)
      Returns:
      APIimageCreateRequest

    • message

      public ImagesCompatApi.APIimageCreateRequest message(String message)
      Set message
      Parameters:
      message - Set commit message for imported image. (optional)
      Returns:
      APIimageCreateRequest

    • platform

      public ImagesCompatApi.APIimageCreateRequest platform(String platform)
      Set platform
      Parameters:
      platform - Platform in the format os[/arch[/variant]] (optional)
      Returns:
      APIimageCreateRequest

    • inputImage

      public ImagesCompatApi.APIimageCreateRequest inputImage(File inputImage)
      Set inputImage
      Parameters:
      inputImage - Image content if fromSrc parameter was used (optional)
      Returns:
      APIimageCreateRequest

    • buildCall

      public okhttp3.Call buildCall(ApiCallback _callback) throws ApiException
      Build call for imageCreate
      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 no error -
      404 No such image -
      500 Internal server error -

    • execute

      public File execute() throws ApiException
      Execute imageCreate request
      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 -

    • executeWithHttpInfo

      public ApiResponse<File> executeWithHttpInfo() throws ApiException
      Execute imageCreate request with HTTP info returned
      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 -

    • executeAsync

      public okhttp3.Call executeAsync(ApiCallback<File> _callback) throws ApiException
      Execute imageCreate 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 no error -
      404 No such image -
      500 Internal server error -