AbstractAmazonECRPublic (AWS Java SDK for Amazon Elastic Container Registry Public 1.12.49 API)

java.lang.Object
- com.amazonaws.services.ecrpublic.AbstractAmazonECRPublic

All Implemented Interfaces:

AmazonECRPublic

Direct Known Subclasses:

AbstractAmazonECRPublicAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonECRPublic
extends Object
implements AmazonECRPublic
```
Abstract implementation of AmazonECRPublic. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.ecrpublic.AmazonECRPublic
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractAmazonECRPublic()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractAmazonECRPublic()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchCheckLayerAvailabilityResult`	`batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest request)` Checks the availability of one or more image layers within a repository in a public registry.
`BatchDeleteImageResult`	`batchDeleteImage(BatchDeleteImageRequest request)` Deletes a list of specified images within a repository in a public registry.
`CompleteLayerUploadResult`	`completeLayerUpload(CompleteLayerUploadRequest request)` Informs Amazon ECR that the image layer upload has completed for a specified public registry, repository name, and upload ID.
`CreateRepositoryResult`	`createRepository(CreateRepositoryRequest request)` Creates a repository in a public registry.
`DeleteRepositoryResult`	`deleteRepository(DeleteRepositoryRequest request)` Deletes a repository in a public registry.
`DeleteRepositoryPolicyResult`	`deleteRepositoryPolicy(DeleteRepositoryPolicyRequest request)` Deletes the repository policy associated with the specified repository.
`DescribeImagesResult`	`describeImages(DescribeImagesRequest request)` Returns metadata about the images in a repository in a public registry.
`DescribeImageTagsResult`	`describeImageTags(DescribeImageTagsRequest request)` Returns the image tag details for a repository in a public registry.
`DescribeRegistriesResult`	`describeRegistries(DescribeRegistriesRequest request)` Returns details for a public registry.
`DescribeRepositoriesResult`	`describeRepositories(DescribeRepositoriesRequest request)` Describes repositories in a public registry.
`GetAuthorizationTokenResult`	`getAuthorizationToken(GetAuthorizationTokenRequest request)` Retrieves an authorization token.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetRegistryCatalogDataResult`	`getRegistryCatalogData(GetRegistryCatalogDataRequest request)` Retrieves catalog metadata for a public registry.
`GetRepositoryCatalogDataResult`	`getRepositoryCatalogData(GetRepositoryCatalogDataRequest request)` Retrieve catalog metadata for a repository in a public registry.
`GetRepositoryPolicyResult`	`getRepositoryPolicy(GetRepositoryPolicyRequest request)` Retrieves the repository policy for the specified repository.
`InitiateLayerUploadResult`	`initiateLayerUpload(InitiateLayerUploadRequest request)` Notifies Amazon ECR that you intend to upload an image layer.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` List the tags for an Amazon ECR Public resource.
`PutImageResult`	`putImage(PutImageRequest request)` Creates or updates the image manifest and tags associated with an image.
`PutRegistryCatalogDataResult`	`putRegistryCatalogData(PutRegistryCatalogDataRequest request)` Create or updates the catalog data for a public registry.
`PutRepositoryCatalogDataResult`	`putRepositoryCatalogData(PutRepositoryCatalogDataRequest request)` Creates or updates the catalog data for a repository in a public registry.
`SetRepositoryPolicyResult`	`setRepositoryPolicy(SetRepositoryPolicyRequest request)` Applies a repository policy to the specified public repository to control access permissions.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Associates the specified tags to a resource with the specified `resourceArn`.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Deletes specified tags from a resource.
`UploadLayerPartResult`	`uploadLayerPart(UploadLayerPartRequest request)` Uploads an image layer part to Amazon ECR.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractAmazonECRPublic
```
protected AbstractAmazonECRPublic()
```
- Method Detail
  - batchCheckLayerAvailability
```
public BatchCheckLayerAvailabilityResult batchCheckLayerAvailability(BatchCheckLayerAvailabilityRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Checks the availability of one or more image layers within a repository in a public registry. When an image is pushed to a repository, each image layer is checked to verify if it has been uploaded before. If it has been uploaded, then the image layer is skipped.
    
    This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
    
    Specified by:
    
    batchCheckLayerAvailability in interface AmazonECRPublic
    
    Returns:
    
    Result of the BatchCheckLayerAvailability operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchDeleteImage
```
public BatchDeleteImageResult batchDeleteImage(BatchDeleteImageRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Deletes a list of specified images within a repository in a public registry. Images are specified with either an imageTag or imageDigest.
    
    You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.
    
    You can completely delete an image (and all of its tags) by specifying the image's digest in your request.
    
    Specified by:
    
    batchDeleteImage in interface AmazonECRPublic
    
    Returns:
    
    Result of the BatchDeleteImage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - completeLayerUpload
```
public CompleteLayerUploadResult completeLayerUpload(CompleteLayerUploadRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Informs Amazon ECR that the image layer upload has completed for a specified public registry, repository name, and upload ID. You can optionally provide a sha256 digest of the image layer for data validation purposes.
    
    When an image is pushed, the CompleteLayerUpload API is called once per each new image layer to verify that the upload has completed.
    
    This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
    
    Specified by:
    
    completeLayerUpload in interface AmazonECRPublic
    
    Returns:
    
    Result of the CompleteLayerUpload operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createRepository
```
public CreateRepositoryResult createRepository(CreateRepositoryRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Creates a repository in a public registry. For more information, see Amazon ECR repositories in the Amazon Elastic Container Registry User Guide.
    
    Specified by:
    
    createRepository in interface AmazonECRPublic
    
    Returns:
    
    Result of the CreateRepository operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteRepository
```
public DeleteRepositoryResult deleteRepository(DeleteRepositoryRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Deletes a repository in a public registry. If the repository contains images, you must either delete all images in the repository or use the force option which deletes all images on your behalf before deleting the repository.
    
    Specified by:
    
    deleteRepository in interface AmazonECRPublic
    
    Returns:
    
    Result of the DeleteRepository operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteRepositoryPolicy
```
public DeleteRepositoryPolicyResult deleteRepositoryPolicy(DeleteRepositoryPolicyRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Deletes the repository policy associated with the specified repository.
    
    Specified by:
    
    deleteRepositoryPolicy in interface AmazonECRPublic
    
    Returns:
    
    Result of the DeleteRepositoryPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeImageTags
```
public DescribeImageTagsResult describeImageTags(DescribeImageTagsRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Returns the image tag details for a repository in a public registry.
    
    Specified by:
    
    describeImageTags in interface AmazonECRPublic
    
    Returns:
    
    Result of the DescribeImageTags operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeImages
```
public DescribeImagesResult describeImages(DescribeImagesRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Returns metadata about the images in a repository in a public registry.
    
    Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.
    
    Specified by:
    
    describeImages in interface AmazonECRPublic
    
    Returns:
    
    Result of the DescribeImages operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeRegistries
```
public DescribeRegistriesResult describeRegistries(DescribeRegistriesRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Returns details for a public registry.
    
    Specified by:
    
    describeRegistries in interface AmazonECRPublic
    
    Returns:
    
    Result of the DescribeRegistries operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeRepositories
```
public DescribeRepositoriesResult describeRepositories(DescribeRepositoriesRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Describes repositories in a public registry.
    
    Specified by:
    
    describeRepositories in interface AmazonECRPublic
    
    Returns:
    
    Result of the DescribeRepositories operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAuthorizationToken
```
public GetAuthorizationTokenResult getAuthorizationToken(GetAuthorizationTokenRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours. This API requires the ecr-public:GetAuthorizationToken and sts:GetServiceBearerToken permissions.
    
    Specified by:
    
    getAuthorizationToken in interface AmazonECRPublic
    
    Returns:
    
    Result of the GetAuthorizationToken operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getRegistryCatalogData
```
public GetRegistryCatalogDataResult getRegistryCatalogData(GetRegistryCatalogDataRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Retrieves catalog metadata for a public registry.
    
    Specified by:
    
    getRegistryCatalogData in interface AmazonECRPublic
    
    Returns:
    
    Result of the GetRegistryCatalogData operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getRepositoryCatalogData
```
public GetRepositoryCatalogDataResult getRepositoryCatalogData(GetRepositoryCatalogDataRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Retrieve catalog metadata for a repository in a public registry. This metadata is displayed publicly in the Amazon ECR Public Gallery.
    
    Specified by:
    
    getRepositoryCatalogData in interface AmazonECRPublic
    
    Returns:
    
    Result of the GetRepositoryCatalogData operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getRepositoryPolicy
```
public GetRepositoryPolicyResult getRepositoryPolicy(GetRepositoryPolicyRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Retrieves the repository policy for the specified repository.
    
    Specified by:
    
    getRepositoryPolicy in interface AmazonECRPublic
    
    Returns:
    
    Result of the GetRepositoryPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - initiateLayerUpload
```
public InitiateLayerUploadResult initiateLayerUpload(InitiateLayerUploadRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Notifies Amazon ECR that you intend to upload an image layer.
    
    When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action.
    
    This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
    
    Specified by:
    
    initiateLayerUpload in interface AmazonECRPublic
    
    Returns:
    
    Result of the InitiateLayerUpload operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    List the tags for an Amazon ECR Public resource.
    
    Specified by:
    
    listTagsForResource in interface AmazonECRPublic
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putImage
```
public PutImageResult putImage(PutImageRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Creates or updates the image manifest and tags associated with an image.
    
    When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image.
    
    This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
    
    Specified by:
    
    putImage in interface AmazonECRPublic
    
    Returns:
    
    Result of the PutImage operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putRegistryCatalogData
```
public PutRegistryCatalogDataResult putRegistryCatalogData(PutRegistryCatalogDataRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Create or updates the catalog data for a public registry.
    
    Specified by:
    
    putRegistryCatalogData in interface AmazonECRPublic
    
    Returns:
    
    Result of the PutRegistryCatalogData operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putRepositoryCatalogData
```
public PutRepositoryCatalogDataResult putRepositoryCatalogData(PutRepositoryCatalogDataRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Creates or updates the catalog data for a repository in a public registry.
    
    Specified by:
    
    putRepositoryCatalogData in interface AmazonECRPublic
    
    Returns:
    
    Result of the PutRepositoryCatalogData operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - setRepositoryPolicy
```
public SetRepositoryPolicyResult setRepositoryPolicy(SetRepositoryPolicyRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Applies a repository policy to the specified public repository to control access permissions. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide.
    
    Specified by:
    
    setRepositoryPolicy in interface AmazonECRPublic
    
    Returns:
    
    Result of the SetRepositoryPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.
    
    Specified by:
    
    tagResource in interface AmazonECRPublic
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Deletes specified tags from a resource.
    
    Specified by:
    
    untagResource in interface AmazonECRPublic
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - uploadLayerPart
```
public UploadLayerPartResult uploadLayerPart(UploadLayerPartRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    Uploads an image layer part to Amazon ECR.
    
    When an image is pushed, each new image layer is uploaded in parts. The maximum size of each image layer part can be 20971520 bytes (or about 20MB). The UploadLayerPart API is called once per each new image layer part.
    
    This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.
    
    Specified by:
    
    uploadLayerPart in interface AmazonECRPublic
    
    Returns:
    
    Result of the UploadLayerPart operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonECRPublic
    
    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.
    
    Specified by:
    
    shutdown in interface AmazonECRPublic
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonECRPublic
    
    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 interface AmazonECRPublic
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Class AbstractAmazonECRPublic

Field Summary

Fields inherited from interface com.amazonaws.services.ecrpublic.AmazonECRPublic

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractAmazonECRPublic

Method Detail

batchCheckLayerAvailability

batchDeleteImage

completeLayerUpload

createRepository

deleteRepository

deleteRepositoryPolicy

describeImageTags

describeImages

describeRegistries

describeRepositories

getAuthorizationToken

getRegistryCatalogData

getRepositoryCatalogData

getRepositoryPolicy

initiateLayerUpload

listTagsForResource

putImage

putRegistryCatalogData

putRepositoryCatalogData

setRepositoryPolicy

tagResource

untagResource

uploadLayerPart

shutdown

getCachedResponseMetadata