Class AbstractAmazonECR
- All Implemented Interfaces:
AmazonECR
- Direct Known Subclasses:
AbstractAmazonECRAsync
AmazonECR
. Convenient method forms pass
through to the corresponding overload that takes a request object, which
throws an UnsupportedOperationException
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionCheck the availability of multiple image layers in a specified registry and repository.batchDeleteImage
(BatchDeleteImageRequest request) Deletes a list of specified images within a specified repository.batchGetImage
(BatchGetImageRequest request) Gets detailed information for specified images within a specified repository.Inform Amazon ECR that the image layer upload for a specified registry, repository name, and upload ID, has completed.createRepository
(CreateRepositoryRequest request) Creates an image repository.deleteRepository
(DeleteRepositoryRequest request) Deletes an existing image repository.Deletes the repository policy from a specified repository.Describes image repositories in a registry.Retrieves a token that is valid for a specified registry for 12 hours.Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer.Retrieves the repository policy for a specified repository.Notify Amazon ECR that you intend to upload an image layer.listImages
(ListImagesRequest request) Lists all the image IDs for a given repository.putImage
(PutImageRequest request) Creates or updates the image manifest associated with an image.void
setEndpoint
(String endpoint) Overrides the default endpoint for this client ("ecr.us-east-1.amazonaws.com").void
An alternative toAmazonECR.setEndpoint(String)
, sets the regional endpoint for this client's service calls.Applies a repository policy on a specified repository to control access permissions.void
shutdown()
Shuts down this client object, releasing any resources that might be held open.uploadLayerPart
(UploadLayerPartRequest request) Uploads an image layer part to Amazon ECR.
-
Constructor Details
-
AbstractAmazonECR
protected AbstractAmazonECR()
-
-
Method Details
-
setEndpoint
Description copied from interface:AmazonECR
Overrides 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
ClientConfiguration
will 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:
setEndpoint
in 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
Description copied from interface:AmazonECR
An 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
ClientConfiguration
supplied 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:
setRegion
in 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:
-
batchCheckLayerAvailability
public BatchCheckLayerAvailabilityResult batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest request) Description copied from interface: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.- Specified by:
batchCheckLayerAvailability
in interfaceAmazonECR
- Returns:
- Result of the BatchCheckLayerAvailability operation returned by the service.
-
batchDeleteImage
Description copied from interface:AmazonECR
Deletes a list of specified images within a specified repository. Images are specified with either
imageTag
orimageDigest
.- Specified by:
batchDeleteImage
in interfaceAmazonECR
- Parameters:
request
- Deletes specified images within a specified repository. Images are specified with either theimageTag
orimageDigest
.- Returns:
- Result of the BatchDeleteImage operation returned by the service.
-
batchGetImage
Description copied from interface:AmazonECR
Gets detailed information for specified images within a specified repository. Images are specified with either
imageTag
orimageDigest
.- Specified by:
batchGetImage
in interfaceAmazonECR
- Returns:
- Result of the BatchGetImage operation returned by the service.
-
completeLayerUpload
Description copied from interface:AmazonECR
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.- Specified by:
completeLayerUpload
in interfaceAmazonECR
- Returns:
- Result of the CompleteLayerUpload operation returned by the service.
-
createRepository
Description copied from interface:AmazonECR
Creates an image repository.
- Specified by:
createRepository
in interfaceAmazonECR
- Returns:
- Result of the CreateRepository operation returned by the service.
-
deleteRepository
Description copied from interface:AmazonECR
Deletes an existing image repository. If a repository contains images, you must use the
force
option to delete it.- Specified by:
deleteRepository
in interfaceAmazonECR
- Returns:
- Result of the DeleteRepository operation returned by the service.
-
deleteRepositoryPolicy
Description copied from interface:AmazonECR
Deletes the repository policy from a specified repository.
- Specified by:
deleteRepositoryPolicy
in interfaceAmazonECR
- Returns:
- Result of the DeleteRepositoryPolicy operation returned by the service.
-
describeRepositories
Description copied from interface:AmazonECR
Describes image repositories in a registry.
- Specified by:
describeRepositories
in interfaceAmazonECR
- Returns:
- Result of the DescribeRepositories operation returned by the service.
-
getAuthorizationToken
Description copied from interface:AmazonECR
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 adocker login
command to authenticate to a registry. The AWS CLI offers anaws ecr get-login
command that simplifies the login process.- Specified by:
getAuthorizationToken
in interfaceAmazonECR
- Returns:
- Result of the GetAuthorizationToken operation returned by the service.
-
getDownloadUrlForLayer
Description copied from interface:AmazonECR
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.- Specified by:
getDownloadUrlForLayer
in interfaceAmazonECR
- Returns:
- Result of the GetDownloadUrlForLayer operation returned by the service.
-
getRepositoryPolicy
Description copied from interface:AmazonECR
Retrieves the repository policy for a specified repository.
- Specified by:
getRepositoryPolicy
in interfaceAmazonECR
- Returns:
- Result of the GetRepositoryPolicy operation returned by the service.
-
initiateLayerUpload
Description copied from interface:AmazonECR
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.- Specified by:
initiateLayerUpload
in interfaceAmazonECR
- Returns:
- Result of the InitiateLayerUpload operation returned by the service.
-
listImages
Description copied from interface:AmazonECR
Lists all the image IDs for a given repository.
- Specified by:
listImages
in interfaceAmazonECR
- Returns:
- Result of the ListImages operation returned by the service.
-
putImage
Description copied from interface:AmazonECR
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. -
setRepositoryPolicy
Description copied from interface:AmazonECR
Applies a repository policy on a specified repository to control access permissions.
- Specified by:
setRepositoryPolicy
in interfaceAmazonECR
- Returns:
- Result of the SetRepositoryPolicy operation returned by the service.
-
uploadLayerPart
Description copied from interface:AmazonECR
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.- Specified by:
uploadLayerPart
in interfaceAmazonECR
- Returns:
- Result of the UploadLayerPart operation returned by the service.
-
shutdown
public void shutdown()Description copied from interface:AmazonECR
Shuts 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
Description copied from interface:AmazonECR
Returns 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:
getCachedResponseMetadata
in interfaceAmazonECR
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-