com.amazonaws.services.ecr.AmazonECRAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
* Copyright 2011-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not
* use this file except in compliance with the License. A copy of the License is
* located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.ecr;
import com.amazonaws.services.ecr.model.*;
/**
* Interface for accessing Amazon ECR asynchronously. Each asynchronous method
* will return a Java Future object representing the asynchronous operation;
* overloads which accept an {@code AsyncHandler} can be used to receive
* notification when an asynchronous operation completes.
*
*
* Amazon EC2 Container Registry (Amazon ECR) is a managed AWS Docker registry
* service. Customers can use the familiar Docker CLI to push, pull, and manage
* images. Amazon ECR provides a secure, scalable, and reliable registry. Amazon
* ECR supports private Docker repositories with resource-based permissions
* using AWS IAM so that specific users or Amazon EC2 instances can access
* repositories and images. Developers can use the Docker CLI to author and
* manage images.
*
*/
public interface AmazonECRAsync extends AmazonECR {
/**
*
* Check the availability of multiple image layers in a specified registry
* and repository.
*
*
*
* This operation is used by the Amazon ECR proxy, and it is not intended
* for general use by customers. Use the docker CLI to pull,
* tag, and push images.
*
*
*
* @param batchCheckLayerAvailabilityRequest
* @return A Java Future containing the result of the
* BatchCheckLayerAvailability operation returned by the service.
* @sample AmazonECRAsync.BatchCheckLayerAvailability
*/
java.util.concurrent.Future batchCheckLayerAvailabilityAsync(
BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest);
/**
*
* Check the availability of multiple image layers in a specified registry
* and repository.
*
*
*
* This operation is used by the Amazon ECR proxy, and it is not intended
* for general use by customers. Use the docker CLI to pull,
* tag, and push images.
*
*
*
* @param batchCheckLayerAvailabilityRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the
* BatchCheckLayerAvailability operation returned by the service.
* @sample AmazonECRAsyncHandler.BatchCheckLayerAvailability
*/
java.util.concurrent.Future batchCheckLayerAvailabilityAsync(
BatchCheckLayerAvailabilityRequest batchCheckLayerAvailabilityRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes a list of specified images within a specified repository. Images
* are specified with either imageTag or
* imageDigest.
*
*
* @param batchDeleteImageRequest
* Deletes specified images within a specified repository. Images are
* specified with either the imageTag or
* imageDigest.
* @return A Java Future containing the result of the BatchDeleteImage
* operation returned by the service.
* @sample AmazonECRAsync.BatchDeleteImage
*/
java.util.concurrent.Future batchDeleteImageAsync(
BatchDeleteImageRequest batchDeleteImageRequest);
/**
*
* Deletes a list of specified images within a specified repository. Images
* are specified with either imageTag or
* imageDigest.
*
*
* @param batchDeleteImageRequest
* Deletes specified images within a specified repository. Images are
* specified with either the imageTag or
* imageDigest.
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the BatchDeleteImage
* operation returned by the service.
* @sample AmazonECRAsyncHandler.BatchDeleteImage
*/
java.util.concurrent.Future batchDeleteImageAsync(
BatchDeleteImageRequest batchDeleteImageRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Gets detailed information for specified images within a specified
* repository. Images are specified with either imageTag or
* imageDigest.
*
*
* @param batchGetImageRequest
* @return A Java Future containing the result of the BatchGetImage
* operation returned by the service.
* @sample AmazonECRAsync.BatchGetImage
*/
java.util.concurrent.Future batchGetImageAsync(
BatchGetImageRequest batchGetImageRequest);
/**
*
* Gets detailed information for specified images within a specified
* repository. Images are specified with either imageTag or
* imageDigest.
*
*
* @param batchGetImageRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the BatchGetImage
* operation returned by the service.
* @sample AmazonECRAsyncHandler.BatchGetImage
*/
java.util.concurrent.Future batchGetImageAsync(
BatchGetImageRequest batchGetImageRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Inform Amazon ECR that the image layer upload for a specified registry,
* repository name, and upload ID, has completed. You can optionally provide
* a sha256 digest of the image layer for data validation
* purposes.
*
*
*
* This operation is used by the Amazon ECR proxy, and it is not intended
* for general use by customers. Use the docker CLI to pull,
* tag, and push images.
*
*
*
* @param completeLayerUploadRequest
* @return A Java Future containing the result of the CompleteLayerUpload
* operation returned by the service.
* @sample AmazonECRAsync.CompleteLayerUpload
*/
java.util.concurrent.Future completeLayerUploadAsync(
CompleteLayerUploadRequest completeLayerUploadRequest);
/**
*
* Inform Amazon ECR that the image layer upload for a specified registry,
* repository name, and upload ID, has completed. You can optionally provide
* a sha256 digest of the image layer for data validation
* purposes.
*
*
*
* This operation is used by the Amazon ECR proxy, and it is not intended
* for general use by customers. Use the docker CLI to pull,
* tag, and push images.
*
*
*
* @param completeLayerUploadRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CompleteLayerUpload
* operation returned by the service.
* @sample AmazonECRAsyncHandler.CompleteLayerUpload
*/
java.util.concurrent.Future completeLayerUploadAsync(
CompleteLayerUploadRequest completeLayerUploadRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates an image repository.
*
*
* @param createRepositoryRequest
* @return A Java Future containing the result of the CreateRepository
* operation returned by the service.
* @sample AmazonECRAsync.CreateRepository
*/
java.util.concurrent.Future createRepositoryAsync(
CreateRepositoryRequest createRepositoryRequest);
/**
*
* Creates an image repository.
*
*
* @param createRepositoryRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the CreateRepository
* operation returned by the service.
* @sample AmazonECRAsyncHandler.CreateRepository
*/
java.util.concurrent.Future createRepositoryAsync(
CreateRepositoryRequest createRepositoryRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes an existing image repository. If a repository contains images,
* you must use the force option to delete it.
*
*
* @param deleteRepositoryRequest
* @return A Java Future containing the result of the DeleteRepository
* operation returned by the service.
* @sample AmazonECRAsync.DeleteRepository
*/
java.util.concurrent.Future deleteRepositoryAsync(
DeleteRepositoryRequest deleteRepositoryRequest);
/**
*
* Deletes an existing image repository. If a repository contains images,
* you must use the force option to delete it.
*
*
* @param deleteRepositoryRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteRepository
* operation returned by the service.
* @sample AmazonECRAsyncHandler.DeleteRepository
*/
java.util.concurrent.Future deleteRepositoryAsync(
DeleteRepositoryRequest deleteRepositoryRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Deletes the repository policy from a specified repository.
*
*
* @param deleteRepositoryPolicyRequest
* @return A Java Future containing the result of the DeleteRepositoryPolicy
* operation returned by the service.
* @sample AmazonECRAsync.DeleteRepositoryPolicy
*/
java.util.concurrent.Future deleteRepositoryPolicyAsync(
DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest);
/**
*
* Deletes the repository policy from a specified repository.
*
*
* @param deleteRepositoryPolicyRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DeleteRepositoryPolicy
* operation returned by the service.
* @sample AmazonECRAsyncHandler.DeleteRepositoryPolicy
*/
java.util.concurrent.Future deleteRepositoryPolicyAsync(
DeleteRepositoryPolicyRequest deleteRepositoryPolicyRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Describes image repositories in a registry.
*
*
* @param describeRepositoriesRequest
* @return A Java Future containing the result of the DescribeRepositories
* operation returned by the service.
* @sample AmazonECRAsync.DescribeRepositories
*/
java.util.concurrent.Future describeRepositoriesAsync(
DescribeRepositoriesRequest describeRepositoriesRequest);
/**
*
* Describes image repositories in a registry.
*
*
* @param describeRepositoriesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the DescribeRepositories
* operation returned by the service.
* @sample AmazonECRAsyncHandler.DescribeRepositories
*/
java.util.concurrent.Future describeRepositoriesAsync(
DescribeRepositoriesRequest describeRepositoriesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves a token that is valid for a specified registry for 12 hours.
* This command allows you to use the docker CLI to push and
* pull images with Amazon ECR. If you do not specify a registry, the
* default registry is assumed.
*
*
* The authorizationToken returned for each registry specified
* is a base64 encoded string that can be decoded and used in a
* docker login command to authenticate to a registry. The AWS
* CLI offers an aws ecr get-login command that simplifies the
* login process.
*
*
* @param getAuthorizationTokenRequest
* @return A Java Future containing the result of the GetAuthorizationToken
* operation returned by the service.
* @sample AmazonECRAsync.GetAuthorizationToken
*/
java.util.concurrent.Future getAuthorizationTokenAsync(
GetAuthorizationTokenRequest getAuthorizationTokenRequest);
/**
*
* Retrieves a token that is valid for a specified registry for 12 hours.
* This command allows you to use the docker CLI to push and
* pull images with Amazon ECR. If you do not specify a registry, the
* default registry is assumed.
*
*
* The authorizationToken returned for each registry specified
* is a base64 encoded string that can be decoded and used in a
* docker login command to authenticate to a registry. The AWS
* CLI offers an aws ecr get-login command that simplifies the
* login process.
*
*
* @param getAuthorizationTokenRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetAuthorizationToken
* operation returned by the service.
* @sample AmazonECRAsyncHandler.GetAuthorizationToken
*/
java.util.concurrent.Future getAuthorizationTokenAsync(
GetAuthorizationTokenRequest getAuthorizationTokenRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves the pre-signed Amazon S3 download URL corresponding to an image
* layer. You can only get URLs for image layers that are referenced in an
* image.
*
*
*
* This operation is used by the Amazon ECR proxy, and it is not intended
* for general use by customers. Use the docker CLI to pull,
* tag, and push images.
*
*
*
* @param getDownloadUrlForLayerRequest
* @return A Java Future containing the result of the GetDownloadUrlForLayer
* operation returned by the service.
* @sample AmazonECRAsync.GetDownloadUrlForLayer
*/
java.util.concurrent.Future getDownloadUrlForLayerAsync(
GetDownloadUrlForLayerRequest getDownloadUrlForLayerRequest);
/**
*
* Retrieves the pre-signed Amazon S3 download URL corresponding to an image
* layer. You can only get URLs for image layers that are referenced in an
* image.
*
*
*
* This operation is used by the Amazon ECR proxy, and it is not intended
* for general use by customers. Use the docker CLI to pull,
* tag, and push images.
*
*
*
* @param getDownloadUrlForLayerRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetDownloadUrlForLayer
* operation returned by the service.
* @sample AmazonECRAsyncHandler.GetDownloadUrlForLayer
*/
java.util.concurrent.Future getDownloadUrlForLayerAsync(
GetDownloadUrlForLayerRequest getDownloadUrlForLayerRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Retrieves the repository policy for a specified repository.
*
*
* @param getRepositoryPolicyRequest
* @return A Java Future containing the result of the GetRepositoryPolicy
* operation returned by the service.
* @sample AmazonECRAsync.GetRepositoryPolicy
*/
java.util.concurrent.Future getRepositoryPolicyAsync(
GetRepositoryPolicyRequest getRepositoryPolicyRequest);
/**
*
* Retrieves the repository policy for a specified repository.
*
*
* @param getRepositoryPolicyRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the GetRepositoryPolicy
* operation returned by the service.
* @sample AmazonECRAsyncHandler.GetRepositoryPolicy
*/
java.util.concurrent.Future getRepositoryPolicyAsync(
GetRepositoryPolicyRequest getRepositoryPolicyRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Notify Amazon ECR that you intend to upload an image layer.
*
*
*
* This operation is used by the Amazon ECR proxy, and it is not intended
* for general use by customers. Use the docker CLI to pull,
* tag, and push images.
*
*
*
* @param initiateLayerUploadRequest
* @return A Java Future containing the result of the InitiateLayerUpload
* operation returned by the service.
* @sample AmazonECRAsync.InitiateLayerUpload
*/
java.util.concurrent.Future initiateLayerUploadAsync(
InitiateLayerUploadRequest initiateLayerUploadRequest);
/**
*
* Notify Amazon ECR that you intend to upload an image layer.
*
*
*
* This operation is used by the Amazon ECR proxy, and it is not intended
* for general use by customers. Use the docker CLI to pull,
* tag, and push images.
*
*
*
* @param initiateLayerUploadRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the InitiateLayerUpload
* operation returned by the service.
* @sample AmazonECRAsyncHandler.InitiateLayerUpload
*/
java.util.concurrent.Future initiateLayerUploadAsync(
InitiateLayerUploadRequest initiateLayerUploadRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Lists all the image IDs for a given repository.
*
*
* @param listImagesRequest
* @return A Java Future containing the result of the ListImages operation
* returned by the service.
* @sample AmazonECRAsync.ListImages
*/
java.util.concurrent.Future listImagesAsync(
ListImagesRequest listImagesRequest);
/**
*
* Lists all the image IDs for a given repository.
*
*
* @param listImagesRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the ListImages operation
* returned by the service.
* @sample AmazonECRAsyncHandler.ListImages
*/
java.util.concurrent.Future listImagesAsync(
ListImagesRequest listImagesRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Creates or updates the image manifest associated with an image.
*
*
*
* This operation is used by the Amazon ECR proxy, and it is not intended
* for general use by customers. Use the docker CLI to pull,
* tag, and push images.
*
*
*
* @param putImageRequest
* @return A Java Future containing the result of the PutImage operation
* returned by the service.
* @sample AmazonECRAsync.PutImage
*/
java.util.concurrent.Future putImageAsync(
PutImageRequest putImageRequest);
/**
*
* Creates or updates the image manifest associated with an image.
*
*
*
* This operation is used by the Amazon ECR proxy, and it is not intended
* for general use by customers. Use the docker CLI to pull,
* tag, and push images.
*
*
*
* @param putImageRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the PutImage operation
* returned by the service.
* @sample AmazonECRAsyncHandler.PutImage
*/
java.util.concurrent.Future putImageAsync(
PutImageRequest putImageRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Applies a repository policy on a specified repository to control access
* permissions.
*
*
* @param setRepositoryPolicyRequest
* @return A Java Future containing the result of the SetRepositoryPolicy
* operation returned by the service.
* @sample AmazonECRAsync.SetRepositoryPolicy
*/
java.util.concurrent.Future setRepositoryPolicyAsync(
SetRepositoryPolicyRequest setRepositoryPolicyRequest);
/**
*
* Applies a repository policy on a specified repository to control access
* permissions.
*
*
* @param setRepositoryPolicyRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the SetRepositoryPolicy
* operation returned by the service.
* @sample AmazonECRAsyncHandler.SetRepositoryPolicy
*/
java.util.concurrent.Future setRepositoryPolicyAsync(
SetRepositoryPolicyRequest setRepositoryPolicyRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Uploads an image layer part to Amazon ECR.
*
*
*
* This operation is used by the Amazon ECR proxy, and it is not intended
* for general use by customers. Use the docker CLI to pull,
* tag, and push images.
*
*
*
* @param uploadLayerPartRequest
* @return A Java Future containing the result of the UploadLayerPart
* operation returned by the service.
* @sample AmazonECRAsync.UploadLayerPart
*/
java.util.concurrent.Future uploadLayerPartAsync(
UploadLayerPartRequest uploadLayerPartRequest);
/**
*
* Uploads an image layer part to Amazon ECR.
*
*
*
* This operation is used by the Amazon ECR proxy, and it is not intended
* for general use by customers. Use the docker CLI to pull,
* tag, and push images.
*
*
*
* @param uploadLayerPartRequest
* @param asyncHandler
* Asynchronous callback handler for events in the lifecycle of the
* request. Users can provide an implementation of the callback
* methods in this interface to receive notification of successful or
* unsuccessful completion of the operation.
* @return A Java Future containing the result of the UploadLayerPart
* operation returned by the service.
* @sample AmazonECRAsyncHandler.UploadLayerPart
*/
java.util.concurrent.Future uploadLayerPartAsync(
UploadLayerPartRequest uploadLayerPartRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}