Class AbstractAmazonECR
- java.lang.Object
-
- com.amazonaws.services.ecr.AbstractAmazonECR
-
- All Implemented Interfaces:
AmazonECR
- Direct Known Subclasses:
AbstractAmazonECRAsync
public class AbstractAmazonECR extends Object implements AmazonECR
Abstract implementation ofAmazonECR. Convenient method forms pass through to the corresponding overload that takes a request object, which throws anUnsupportedOperationException.
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedAbstractAmazonECR()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BatchCheckLayerAvailabilityResultbatchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest request)Check the availability of multiple image layers in a specified registry and repository.BatchDeleteImageResultbatchDeleteImage(BatchDeleteImageRequest request)Deletes a list of specified images within a specified repository.BatchGetImageResultbatchGetImage(BatchGetImageRequest request)Gets detailed information for specified images within a specified repository.CompleteLayerUploadResultcompleteLayerUpload(CompleteLayerUploadRequest request)Inform Amazon ECR that the image layer upload for a specified registry, repository name, and upload ID, has completed.CreateRepositoryResultcreateRepository(CreateRepositoryRequest request)Creates an image repository.DeleteRepositoryResultdeleteRepository(DeleteRepositoryRequest request)Deletes an existing image repository.DeleteRepositoryPolicyResultdeleteRepositoryPolicy(DeleteRepositoryPolicyRequest request)Deletes the repository policy from a specified repository.DescribeRepositoriesResultdescribeRepositories(DescribeRepositoriesRequest request)Describes image repositories in a registry.GetAuthorizationTokenResultgetAuthorizationToken(GetAuthorizationTokenRequest request)Retrieves a token that is valid for a specified registry for 12 hours.ResponseMetadatagetCachedResponseMetadata(AmazonWebServiceRequest request)Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.GetDownloadUrlForLayerResultgetDownloadUrlForLayer(GetDownloadUrlForLayerRequest request)Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer.GetRepositoryPolicyResultgetRepositoryPolicy(GetRepositoryPolicyRequest request)Retrieves the repository policy for a specified repository.InitiateLayerUploadResultinitiateLayerUpload(InitiateLayerUploadRequest request)Notify Amazon ECR that you intend to upload an image layer.ListImagesResultlistImages(ListImagesRequest request)Lists all the image IDs for a given repository.PutImageResultputImage(PutImageRequest request)Creates or updates the image manifest associated with an image.voidsetEndpoint(String endpoint)Overrides the default endpoint for this client ("ecr.us-east-1.amazonaws.com").voidsetRegion(Region region)An alternative toAmazonECR.setEndpoint(String), sets the regional endpoint for this client's service calls.SetRepositoryPolicyResultsetRepositoryPolicy(SetRepositoryPolicyRequest request)Applies a repository policy on a specified repository to control access permissions.voidshutdown()Shuts down this client object, releasing any resources that might be held open.UploadLayerPartResultuploadLayerPart(UploadLayerPartRequest request)Uploads an image layer part to Amazon ECR.
-
-
-
Method Detail
-
setEndpoint
public void setEndpoint(String endpoint)
Description copied from interface:AmazonECROverrides the default endpoint for this client ("ecr.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.Callers can pass in just the endpoint (ex: "ecr.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "ecr.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's
ClientConfigurationwill be used, which by default is HTTPS.For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setEndpointin interfaceAmazonECR- Parameters:
endpoint- The endpoint (ex: "ecr.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "ecr.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
-
setRegion
public void setRegion(Region region)
Description copied from interface:AmazonECRAn alternative toAmazonECR.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfigurationsupplied at construction.This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setRegionin interfaceAmazonECR- Parameters:
region- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
Region.getRegion(com.amazonaws.regions.Regions),Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),Region.isServiceSupported(String)
-
batchCheckLayerAvailability
public BatchCheckLayerAvailabilityResult batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest request)
Description copied from interface:AmazonECRCheck 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
dockerCLI to pull, tag, and push images.- Specified by:
batchCheckLayerAvailabilityin interfaceAmazonECR- Returns:
- Result of the BatchCheckLayerAvailability operation returned by the service.
-
batchDeleteImage
public BatchDeleteImageResult batchDeleteImage(BatchDeleteImageRequest request)
Description copied from interface:AmazonECRDeletes a list of specified images within a specified repository. Images are specified with either
imageTagorimageDigest.- Specified by:
batchDeleteImagein interfaceAmazonECR- Parameters:
request- Deletes specified images within a specified repository. Images are specified with either theimageTagorimageDigest.- Returns:
- Result of the BatchDeleteImage operation returned by the service.
-
batchGetImage
public BatchGetImageResult batchGetImage(BatchGetImageRequest request)
Description copied from interface:AmazonECRGets detailed information for specified images within a specified repository. Images are specified with either
imageTagorimageDigest.- Specified by:
batchGetImagein interfaceAmazonECR- Returns:
- Result of the BatchGetImage operation returned by the service.
-
completeLayerUpload
public CompleteLayerUploadResult completeLayerUpload(CompleteLayerUploadRequest request)
Description copied from interface:AmazonECRInform Amazon ECR that the image layer upload for a specified registry, repository name, and upload ID, has completed. You can optionally provide a
sha256digest 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
dockerCLI to pull, tag, and push images.- Specified by:
completeLayerUploadin interfaceAmazonECR- Returns:
- Result of the CompleteLayerUpload operation returned by the service.
-
createRepository
public CreateRepositoryResult createRepository(CreateRepositoryRequest request)
Description copied from interface:AmazonECRCreates an image repository.
- Specified by:
createRepositoryin interfaceAmazonECR- Returns:
- Result of the CreateRepository operation returned by the service.
-
deleteRepository
public DeleteRepositoryResult deleteRepository(DeleteRepositoryRequest request)
Description copied from interface:AmazonECRDeletes an existing image repository. If a repository contains images, you must use the
forceoption to delete it.- Specified by:
deleteRepositoryin interfaceAmazonECR- Returns:
- Result of the DeleteRepository operation returned by the service.
-
deleteRepositoryPolicy
public DeleteRepositoryPolicyResult deleteRepositoryPolicy(DeleteRepositoryPolicyRequest request)
Description copied from interface:AmazonECRDeletes the repository policy from a specified repository.
- Specified by:
deleteRepositoryPolicyin interfaceAmazonECR- Returns:
- Result of the DeleteRepositoryPolicy operation returned by the service.
-
describeRepositories
public DescribeRepositoriesResult describeRepositories(DescribeRepositoriesRequest request)
Description copied from interface:AmazonECRDescribes image repositories in a registry.
- Specified by:
describeRepositoriesin interfaceAmazonECR- Returns:
- Result of the DescribeRepositories operation returned by the service.
-
getAuthorizationToken
public GetAuthorizationTokenResult getAuthorizationToken(GetAuthorizationTokenRequest request)
Description copied from interface:AmazonECRRetrieves a token that is valid for a specified registry for 12 hours. This command allows you to use the
dockerCLI to push and pull images with Amazon ECR. If you do not specify a registry, the default registry is assumed.The
authorizationTokenreturned for each registry specified is a base64 encoded string that can be decoded and used in adocker logincommand to authenticate to a registry. The AWS CLI offers anaws ecr get-logincommand that simplifies the login process.- Specified by:
getAuthorizationTokenin interfaceAmazonECR- Returns:
- Result of the GetAuthorizationToken operation returned by the service.
-
getDownloadUrlForLayer
public GetDownloadUrlForLayerResult getDownloadUrlForLayer(GetDownloadUrlForLayerRequest request)
Description copied from interface:AmazonECRRetrieves 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
dockerCLI to pull, tag, and push images.- Specified by:
getDownloadUrlForLayerin interfaceAmazonECR- Returns:
- Result of the GetDownloadUrlForLayer operation returned by the service.
-
getRepositoryPolicy
public GetRepositoryPolicyResult getRepositoryPolicy(GetRepositoryPolicyRequest request)
Description copied from interface:AmazonECRRetrieves the repository policy for a specified repository.
- Specified by:
getRepositoryPolicyin interfaceAmazonECR- Returns:
- Result of the GetRepositoryPolicy operation returned by the service.
-
initiateLayerUpload
public InitiateLayerUploadResult initiateLayerUpload(InitiateLayerUploadRequest request)
Description copied from interface:AmazonECRNotify 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
dockerCLI to pull, tag, and push images.- Specified by:
initiateLayerUploadin interfaceAmazonECR- Returns:
- Result of the InitiateLayerUpload operation returned by the service.
-
listImages
public ListImagesResult listImages(ListImagesRequest request)
Description copied from interface:AmazonECRLists all the image IDs for a given repository.
- Specified by:
listImagesin interfaceAmazonECR- Returns:
- Result of the ListImages operation returned by the service.
-
putImage
public PutImageResult putImage(PutImageRequest request)
Description copied from interface:AmazonECRCreates 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
dockerCLI to pull, tag, and push images.
-
setRepositoryPolicy
public SetRepositoryPolicyResult setRepositoryPolicy(SetRepositoryPolicyRequest request)
Description copied from interface:AmazonECRApplies a repository policy on a specified repository to control access permissions.
- Specified by:
setRepositoryPolicyin interfaceAmazonECR- Returns:
- Result of the SetRepositoryPolicy operation returned by the service.
-
uploadLayerPart
public UploadLayerPartResult uploadLayerPart(UploadLayerPartRequest request)
Description copied from interface:AmazonECRUploads 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
dockerCLI to pull, tag, and push images.- Specified by:
uploadLayerPartin interfaceAmazonECR- Returns:
- Result of the UploadLayerPart operation returned by the service.
-
shutdown
public void shutdown()
Description copied from interface:AmazonECRShuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
-
getCachedResponseMetadata
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Description copied from interface:AmazonECRReturns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
- Specified by:
getCachedResponseMetadatain interfaceAmazonECR- Parameters:
request- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-
-