Class ContainerRegistryBlobAsyncClient
java.lang.Object
com.azure.containers.containerregistry.specialized.ContainerRegistryBlobAsyncClient
This class provides a client that exposes operations to push and pull images into container registry.
It exposes methods that upload, download and delete artifacts from the registry i.e. images and manifests.
View this
for additional ways to construct the client.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiondeleteBlob
(String digest) Delete the image associated with the given digestdeleteBlobWithResponse
(String digest) Delete the image associated with the given digestdeleteManifest
(String digest) Delete the manifest associated with the given digest.deleteManifestWithResponse
(String digest) Delete the manifest associated with the given digest.downloadBlob
(String digest) Download the blob associated with the given digest.downloadBlobWithResponse
(String digest) Download the blob\layer associated with the given digest.downloadManifest
(DownloadManifestOptions options) Download the manifest associated with the given tag or digest.Download the manifest associated with the given tag or digest.This method returns the complete registry endpoint.This method returns the registry's repository on which operations are being performed.uploadBlob
(BinaryData data) Uploads a blob to the repository.Uploads a blob to the repository.uploadManifest
(OciManifest manifest) Upload the Oci manifest to the repository.uploadManifest
(UploadManifestOptions options) Uploads a manifest to the repository.Uploads a manifest to the repository.
-
Method Details
-
getRepositoryName
This method returns the registry's repository on which operations are being performed.- Returns:
- The name of the repository
-
getEndpoint
This method returns the complete registry endpoint.- Returns:
- The registry endpoint including the authority.
-
uploadManifest
Upload the Oci manifest to the repository. The upload is done as a single operation.- Parameters:
manifest
- The OciManifest that needs to be uploaded.- Returns:
- operation result.
- Throws:
ClientAuthenticationException
- thrown if the client's credentials do not have access to modify the namespace.NullPointerException
- thrown if themanifest
is null.- See Also:
-
uploadManifest
Uploads a manifest to the repository. The client currently only supports uploading OciManifests to the repository. And this operation makes the assumption that the data provided is a valid OCI manifest.Also, the data is read into memory and then an upload operation is performed as a single operation.
- Parameters:
options
- The options for the upload manifest operation.- Returns:
- operation result.
- Throws:
ClientAuthenticationException
- thrown if the client's credentials do not have access to modify the namespace.NullPointerException
- thrown if thedata
is null.- See Also:
-
uploadManifestWithResponse
public Mono<Response<UploadManifestResult>> uploadManifestWithResponse(UploadManifestOptions options) Uploads a manifest to the repository. The client currently only supports uploading OciManifests to the repository. And this operation makes the assumption that the data provided is a valid OCI manifest.Also, the data is read into memory and then an upload operation is performed as a single operation.
- Parameters:
options
- The options for the upload manifest operation.- Returns:
- The rest response containing the operation result.
- Throws:
ClientAuthenticationException
- thrown if the client's credentials do not have access to modify the namespace.NullPointerException
- thrown if thedata
is null.- See Also:
-
uploadBlob
Uploads a blob to the repository. The client currently uploads the entire blob\layer as a single unit.The blob is read into memory and then an upload operation is performed as a single operation. We currently do not support breaking the layer into multiple chunks and uploading them one at a time
- Parameters:
data
- The blob\image content that needs to be uploaded.- Returns:
- The operation result.
- Throws:
ClientAuthenticationException
- thrown if the client's credentials do not have access to modify the namespace.NullPointerException
- thrown if thedata
is null.
-
uploadBlobWithResponse
Uploads a blob to the repository. The client currently uploads the entire blob\layer as a single unit.The blob is read into memory and then an upload operation is performed as a single operation. We currently do not support breaking the layer into multiple chunks and uploading them one at a time
- Parameters:
data
- The blob\image content that needs to be uploaded.- Returns:
- The rest response containing the operation result.
- Throws:
ClientAuthenticationException
- thrown if the client's credentials do not have access to modify the namespace.NullPointerException
- thrown if thedata
is null.
-
downloadManifest
Download the manifest associated with the given tag or digest. We currently only support downloading OCI manifests.- Parameters:
options
- Options for the operation.- Returns:
- The manifest associated with the given tag or digest.
- Throws:
ClientAuthenticationException
- thrown if the client's credentials do not have access to modify the namespace.NullPointerException
- thrown if thetagOrDigest
is null.- See Also:
-
downloadManifestWithResponse
public Mono<Response<DownloadManifestResult>> downloadManifestWithResponse(DownloadManifestOptions options) Download the manifest associated with the given tag or digest. We currently only support downloading OCI manifests.- Parameters:
options
- The options for the operation.- Returns:
- The response for the manifest associated with the given tag or digest.
- Throws:
ClientAuthenticationException
- thrown if the client's credentials do not have access to modify the namespace.NullPointerException
- thrown if thetagOrDigest
is null.- See Also:
-
downloadBlob
Download the blob associated with the given digest.- Parameters:
digest
- The digest for the given image layer.- Returns:
- The image associated with the given digest.
- Throws:
ClientAuthenticationException
- thrown if the client's credentials do not have access to modify the namespace.NullPointerException
- thrown if thedigest
is null.
-
downloadBlobWithResponse
Download the blob\layer associated with the given digest.- Parameters:
digest
- The digest for the given image layer.- Returns:
- The image associated with the given digest.
- Throws:
ClientAuthenticationException
- thrown if the client's credentials do not have access to modify the namespace.NullPointerException
- thrown if thedigest
is null.
-
deleteBlob
Delete the image associated with the given digest- Parameters:
digest
- The digest for the given image layer.- Returns:
- The completion signal.
- Throws:
ClientAuthenticationException
- thrown if the client's credentials do not have access to modify the namespace.NullPointerException
- thrown if thedigest
is null.
-
deleteBlobWithResponse
Delete the image associated with the given digest- Parameters:
digest
- The digest for the given image layer.- Returns:
- The REST response for the completion.
- Throws:
ClientAuthenticationException
- thrown if the client's credentials do not have access to modify the namespace.NullPointerException
- thrown if thedigest
is null.
-
deleteManifest
Delete the manifest associated with the given digest. We currently only support downloading OCI manifests.- Parameters:
digest
- The digest of the manifest.- Returns:
- The completion.
- Throws:
ClientAuthenticationException
- thrown if the client's credentials do not have access to modify the namespace.NullPointerException
- thrown if thedigest
is null.- See Also:
-
deleteManifestWithResponse
Delete the manifest associated with the given digest. We currently only support downloading OCI manifests.- Parameters:
digest
- The digest of the manifest.- Returns:
- The REST response for completion.
- Throws:
ClientAuthenticationException
- thrown if the client's credentials do not have access to modify the namespace.NullPointerException
- thrown if thedigest
is null.- See Also:
-