BlobContainerAsyncClient (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.storage.blob.BlobContainerAsyncClient

```
public final class BlobContainerAsyncClient
extends Object
```
Client to a container. It may only be instantiated through a BlobContainerClientBuilder or via the method BlobServiceAsyncClient.getBlobContainerAsyncClient(String). This class does not hold any state about a particular blob but is instead a convenient way of sending off appropriate requests to the resource on the service. It may also be used to construct URLs to blobs.
This client contains operations on a container. Operations on a blob are available on BlobAsyncClient through BlobContainerAsyncClient.getBlobAsyncClient(String), and operations on the service are available on BlobServiceAsyncClient.
Please refer to the Azure Docs for more information on containers.
Note this client is an async client that returns reactive responses from Spring Reactor Core project (https://projectreactor.io/). Calling the methods in this client will NOT start the actual network operation, until .subscribe() is called on the reactive response. You can simply convert one of these responses to a CompletableFuture object through Mono.toFuture().

Field Summary

Fields
Modifier and Type Field and Description

static String LOG_CONTAINER_NAME

static String ROOT_CONTAINER_NAME

static String STATIC_WEBSITE_CONTAINER_NAME

Fields
Modifier and Type	Field and Description
`static String`	`LOG_CONTAINER_NAME`
`static String`	`ROOT_CONTAINER_NAME`
`static String`	`STATIC_WEBSITE_CONTAINER_NAME`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Mono<Void>`	`create()` Creates a new container within a storage account.
`Mono<Response<Void>>`	`createWithResponse(Map<String,String> metadata, PublicAccessType accessType)` Creates a new container within a storage account.
`Mono<Void>`	`delete()` Marks the specified container for deletion.
`Mono<Response<Void>>`	`deleteWithResponse(BlobRequestConditions accessConditions)` Marks the specified container for deletion.
`Mono<Boolean>`	`exists()` Gets if the container this client represents exists in the cloud.
`Mono<Response<Boolean>>`	`existsWithResponse()` Gets if the container this client represents exists in the cloud.
`Mono<BlobContainerAccessPolicies>`	`getAccessPolicy()` Returns the container's permissions.
`Mono<Response<BlobContainerAccessPolicies>>`	`getAccessPolicyWithResponse(String leaseId)` Returns the container's permissions.
`Mono<StorageAccountInfo>`	`getAccountInfo()` Returns the sku name and account kind for the account.
`Mono<Response<StorageAccountInfo>>`	`getAccountInfoWithResponse()` Returns the sku name and account kind for the account.
`String`	`getAccountName()` Get associated account name.
`BlobAsyncClient`	`getBlobAsyncClient(String blobName)` Creates a new BlobAsyncClient object by concatenating blobName to the end of ContainerAsyncClient's URL.
`BlobAsyncClient`	`getBlobAsyncClient(String blobName, String snapshot)` Creates a new BlobAsyncClient object by concatenating blobName to the end of ContainerAsyncClient's URL.
`String`	`getBlobContainerName()` Get the container name.
`String`	`getBlobContainerUrl()` Gets the URL of the container represented by this client.
`CpkInfo`	`getCustomerProvidedKey()` Gets the `CpkInfo` associated with this client that will be passed to `BlobAsyncClients` when `getBlobAsyncClient` is called.
`HttpPipeline`	`getHttpPipeline()` Gets the `HttpPipeline` powering this client.
`Mono<BlobContainerProperties>`	`getProperties()` Returns the container's metadata and system properties.
`Mono<Response<BlobContainerProperties>>`	`getPropertiesWithResponse(String leaseId)` Returns the container's metadata and system properties.
`BlobServiceVersion`	`getServiceVersion()` Gets the service version the client is using.
`PagedFlux<BlobItem>`	`listBlobs()` Returns a reactive Publisher emitting all the blobs in this container lazily as needed.
`PagedFlux<BlobItem>`	`listBlobs(ListBlobsOptions options)` Returns a reactive Publisher emitting all the blobs in this container lazily as needed.
`PagedFlux<BlobItem>`	`listBlobsByHierarchy(String directory)` Returns a reactive Publisher emitting all the blobs and directories (prefixes) under the given directory (prefix).
`PagedFlux<BlobItem>`	`listBlobsByHierarchy(String delimiter, ListBlobsOptions options)` Returns a reactive Publisher emitting all the blobs and prefixes (directories) under the given prefix (directory).
`Mono<Void>`	`setAccessPolicy(PublicAccessType accessType, List<BlobSignedIdentifier> identifiers)` Sets the container's permissions.
`Mono<Response<Void>>`	`setAccessPolicyWithResponse(PublicAccessType accessType, List<BlobSignedIdentifier> identifiers, BlobRequestConditions accessConditions)` Sets the container's permissions.
`Mono<Void>`	`setMetadata(Map<String,String> metadata)` Sets the container's metadata.
`Mono<Response<Void>>`	`setMetadataWithResponse(Map<String,String> metadata, BlobRequestConditions accessConditions)` Sets the container's metadata.

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

- Field Detail
  - ROOT_CONTAINER_NAME
```
public static final String ROOT_CONTAINER_NAME
```
    See Also:
    
    Constant Field Values
  - STATIC_WEBSITE_CONTAINER_NAME
```
public static final String STATIC_WEBSITE_CONTAINER_NAME
```
    See Also:
    
    Constant Field Values
  - LOG_CONTAINER_NAME
```
public static final String LOG_CONTAINER_NAME
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getBlobAsyncClient
```
public BlobAsyncClient getBlobAsyncClient(String blobName)
```
    Creates a new BlobAsyncClient object by concatenating blobName to the end of ContainerAsyncClient's URL. The new BlobAsyncClient uses the same request policy pipeline as the ContainerAsyncClient. To change the pipeline, create the BlobAsyncClient and then call its WithPipeline method passing in the desired pipeline object. Or, call this package's getBlobAsyncClient instead of calling this object's getBlobAsyncClient method.
    Code Samples
```
BlobAsyncClient blobAsyncClient = client.getBlobAsyncClient(blobName);
```
    Parameters:
    
    blobName - A String representing the name of the blob.
    
    Returns:
    
    A new BlobAsyncClient object which references the blob with the specified name in this container.
  - getBlobAsyncClient
```
public BlobAsyncClient getBlobAsyncClient(String blobName,
                                          String snapshot)
```
    Creates a new BlobAsyncClient object by concatenating blobName to the end of ContainerAsyncClient's URL. The new BlobAsyncClient uses the same request policy pipeline as the ContainerAsyncClient. To change the pipeline, create the BlobAsyncClient and then call its WithPipeline method passing in the desired pipeline object. Or, call this package's getBlobAsyncClient instead of calling this object's getBlobAsyncClient method.
    Code Samples
```
BlobAsyncClient blobAsyncClient = client.getBlobAsyncClient(blobName, snapshot);
```
    Parameters:
    
    blobName - A String representing the name of the blob.
    
    snapshot - the snapshot identifier for the blob.
    
    Returns:
    
    A new BlobAsyncClient object which references the blob with the specified name in this container.
  - getBlobContainerUrl
```
public String getBlobContainerUrl()
```
    Gets the URL of the container represented by this client.
    
    Returns:
    
    the URL.
  - getBlobContainerName
```
public String getBlobContainerName()
```
    Get the container name.
    Code Samples
```
String containerName = client.getBlobContainerName();
System.out.println("The name of the blob is " + containerName);
```
    Returns:
    
    The name of container.
  - getAccountName
```
public String getAccountName()
```
    Get associated account name.
    
    Returns:
    
    account name associated with this storage resource.
  - getServiceVersion
```
public BlobServiceVersion getServiceVersion()
```
    Gets the service version the client is using.
    
    Returns:
    
    the service version the client is using.
  - getHttpPipeline
```
public HttpPipeline getHttpPipeline()
```
    Gets the HttpPipeline powering this client.
    
    Returns:
    
    The pipeline.
  - getCustomerProvidedKey
```
public CpkInfo getCustomerProvidedKey()
```
    Gets the CpkInfo associated with this client that will be passed to BlobAsyncClients when getBlobAsyncClient is called.
    
    Returns:
    
    the customer provided key used for encryption.
  - exists
```
public Mono<Boolean> exists()
```
    Gets if the container this client represents exists in the cloud.
    Code Samples
```
client.exists().subscribe(response -> System.out.printf("Exists? %b%n", response));
```
    Returns:
    
    true if the container exists, false if it doesn't
  - existsWithResponse
```
public Mono<Response<Boolean>> existsWithResponse()
```
    Gets if the container this client represents exists in the cloud.
    Code Samples
```
client.existsWithResponse().subscribe(response -> System.out.printf("Exists? %b%n", response.getValue()));
```
    Returns:
    
    true if the container exists, false if it doesn't
  - create
```
public Mono<Void> create()
```
    Creates a new container within a storage account. If a container with the same name already exists, the operation fails. For more information, see the Azure Docs.
    Code Samples
```
client.create().subscribe(
    response -> System.out.printf("Create completed%n"),
    error -> System.out.printf("Error while creating container %s%n", error));
```
    Returns:
    
    A reactive response signalling completion.
  - createWithResponse
```
public Mono<Response<Void>> createWithResponse(Map<String,String> metadata,
                                               PublicAccessType accessType)
```
    Creates a new container within a storage account. If a container with the same name already exists, the operation fails. For more information, see the Azure Docs.
    Code Samples
```
Map<String, String> metadata = Collections.singletonMap("metadata", "value");
client.createWithResponse(metadata, PublicAccessType.CONTAINER).subscribe(response ->
    System.out.printf("Create completed with status %d%n", response.getStatusCode()));
```
    Parameters:
    
    metadata - Metadata to associate with the container.
    
    accessType - Specifies how the data in this container is available to the public. See the x-ms-blob-public-access header in the Azure Docs for more information. Pass null for no public access.
    
    Returns:
    
    A reactive response signalling completion.
  - delete
```
public Mono<Void> delete()
```
    Marks the specified container for deletion. The container and any blobs contained within it are later deleted during garbage collection. For more information, see the Azure Docs.
    Code Samples
```
client.delete().subscribe(
    response -> System.out.printf("Delete completed%n"),
    error -> System.out.printf("Delete failed: %s%n", error));
```
    Returns:
    
    A reactive response signalling completion.
  - deleteWithResponse
```
public Mono<Response<Void>> deleteWithResponse(BlobRequestConditions accessConditions)
```
    Marks the specified container for deletion. The container and any blobs contained within it are later deleted during garbage collection. For more information, see the Azure Docs.
    Code Samples
```
BlobRequestConditions accessConditions = new BlobRequestConditions()
    .setLeaseId(leaseId)
    .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));

client.deleteWithResponse(accessConditions).subscribe(response ->
    System.out.printf("Delete completed with status %d%n", response.getStatusCode()));
```
    Parameters:
    
    accessConditions - BlobRequestConditions
    
    Returns:
    
    A reactive response signalling completion.
    
    Throws:
    
    UnsupportedOperationException - If either MatchConditions.getIfMatch() or MatchConditions.getIfNoneMatch() is set.
  - getProperties
```
public Mono<BlobContainerProperties> getProperties()
```
    Returns the container's metadata and system properties. For more information, see the Azure Docs.
    Code Samples
```
client.getProperties().subscribe(response ->
    System.out.printf("Public Access Type: %s, Legal Hold? %b, Immutable? %b%n",
        response.getBlobPublicAccess(),
        response.hasLegalHold(),
        response.hasImmutabilityPolicy()));
```
    Returns:
    
    A Mono containing a Response whose value containing the container properties.
  - getPropertiesWithResponse
```
public Mono<Response<BlobContainerProperties>> getPropertiesWithResponse(String leaseId)
```
    Returns the container's metadata and system properties. For more information, see the Azure Docs.
    Code Samples
```
client.getPropertiesWithResponse(leaseId).subscribe(response ->
    System.out.printf("Public Access Type: %s, Legal Hold? %b, Immutable? %b%n",
        response.getValue().getBlobPublicAccess(),
        response.getValue().hasLegalHold(),
        response.getValue().hasImmutabilityPolicy()));
```
    Parameters:
    
    leaseId - The lease ID the active lease on the container must match.
    
    Returns:
    
    A reactive response containing the container properties.
  - setMetadata
```
public Mono<Void> setMetadata(Map<String,String> metadata)
```
    Sets the container's metadata. For more information, see the Azure Docs.
    Code Samples
```
Map<String, String> metadata = Collections.singletonMap("metadata", "value");
client.setMetadata(metadata).subscribe(
    response -> System.out.printf("Set metadata completed%n"),
    error -> System.out.printf("Set metadata failed: %s%n", error));
```
    Parameters:
    
    metadata - Metadata to associate with the container.
    
    Returns:
    
    A Mono containing a Response whose value contains signalling completion.
  - setMetadataWithResponse
```
public Mono<Response<Void>> setMetadataWithResponse(Map<String,String> metadata,
                                                    BlobRequestConditions accessConditions)
```
    Sets the container's metadata. For more information, see the Azure Docs.
    Code Samples
```
Map<String, String> metadata = Collections.singletonMap("metadata", "value");
BlobRequestConditions accessConditions = new BlobRequestConditions()
    .setLeaseId(leaseId)
    .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));

client.setMetadataWithResponse(metadata, accessConditions).subscribe(response ->
    System.out.printf("Set metadata completed with status %d%n", response.getStatusCode()));
```
    Parameters:
    
    metadata - Metadata to associate with the container.
    
    accessConditions - BlobRequestConditions
    
    Returns:
    
    A reactive response signalling completion.
    
    Throws:
    
    UnsupportedOperationException - If one of MatchConditions.getIfMatch(), MatchConditions.getIfNoneMatch(), or RequestConditions.getIfUnmodifiedSince() is set.
  - getAccessPolicy
```
public Mono<BlobContainerAccessPolicies> getAccessPolicy()
```
    Returns the container's permissions. The permissions indicate whether container's blobs may be accessed publicly. For more information, see the Azure Docs.
    Code Samples
```
client.getAccessPolicy().subscribe(response -> {
    System.out.printf("Blob Access Type: %s%n", response.getBlobAccessType());

    for (BlobSignedIdentifier identifier : response.getIdentifiers()) {
        System.out.printf("Identifier Name: %s, Permissions %s%n",
            identifier.getId(),
            identifier.getAccessPolicy().getPermissions());
    }
});
```
    Returns:
    
    A reactive response containing the container access policy.
  - getAccessPolicyWithResponse
```
public Mono<Response<BlobContainerAccessPolicies>> getAccessPolicyWithResponse(String leaseId)
```
    Returns the container's permissions. The permissions indicate whether container's blobs may be accessed publicly. For more information, see the Azure Docs.
    Code Samples
```
client.getAccessPolicyWithResponse(leaseId).subscribe(response -> {
    System.out.printf("Blob Access Type: %s%n", response.getValue().getBlobAccessType());

    for (BlobSignedIdentifier identifier : response.getValue().getIdentifiers()) {
        System.out.printf("Identifier Name: %s, Permissions %s%n",
            identifier.getId(),
            identifier.getAccessPolicy().getPermissions());
    }
});
```
    Parameters:
    
    leaseId - The lease ID the active lease on the container must match.
    
    Returns:
    
    A reactive response containing the container access policy.
  - setAccessPolicy
```
public Mono<Void> setAccessPolicy(PublicAccessType accessType,
                                  List<BlobSignedIdentifier> identifiers)
```
    Sets the container's permissions. The permissions indicate whether blobs in a container may be accessed publicly. Note that, for each signed identifier, we will truncate the start and expiry times to the nearest second to ensure the time formatting is compatible with the service. For more information, see the Azure Docs.
    Code Samples
```
BlobSignedIdentifier identifier = new BlobSignedIdentifier()
    .setId("name")
    .setAccessPolicy(new BlobAccessPolicy()
        .setStartsOn(OffsetDateTime.now())
        .setExpiresOn(OffsetDateTime.now().plusDays(7))
        .setPermissions("permissionString"));

client.setAccessPolicy(PublicAccessType.CONTAINER, Collections.singletonList(identifier)).subscribe(
    response -> System.out.printf("Set access policy completed%n"),
    error -> System.out.printf("Set access policy failed: %s%n", error));
```
    Parameters:
    
    accessType - Specifies how the data in this container is available to the public. See the x-ms-blob-public-access header in the Azure Docs for more information. Pass null for no public access.
    
    identifiers - A list of BlobSignedIdentifier objects that specify the permissions for the container. Please see here for more information. Passing null will clear all access policies.
    
    Returns:
    
    A reactive response signalling completion.
  - setAccessPolicyWithResponse
```
public Mono<Response<Void>> setAccessPolicyWithResponse(PublicAccessType accessType,
                                                        List<BlobSignedIdentifier> identifiers,
                                                        BlobRequestConditions accessConditions)
```
    Sets the container's permissions. The permissions indicate whether blobs in a container may be accessed publicly. Note that, for each signed identifier, we will truncate the start and expiry times to the nearest second to ensure the time formatting is compatible with the service. For more information, see the Azure Docs.
    Code Samples
```
BlobSignedIdentifier identifier = new BlobSignedIdentifier()
    .setId("name")
    .setAccessPolicy(new BlobAccessPolicy()
        .setStartsOn(OffsetDateTime.now())
        .setExpiresOn(OffsetDateTime.now().plusDays(7))
        .setPermissions("permissionString"));

BlobRequestConditions accessConditions = new BlobRequestConditions()
    .setLeaseId(leaseId)
    .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));

client.setAccessPolicyWithResponse(PublicAccessType.CONTAINER, Collections.singletonList(identifier), accessConditions)
    .subscribe(response ->
        System.out.printf("Set access policy completed with status %d%n", response.getStatusCode()));
```
    Parameters:
    
    accessType - Specifies how the data in this container is available to the public. See the x-ms-blob-public-access header in the Azure Docs for more information. Pass null for no public access.
    
    identifiers - A list of BlobSignedIdentifier objects that specify the permissions for the container. Please see here for more information. Passing null will clear all access policies.
    
    accessConditions - BlobRequestConditions
    
    Returns:
    
    A reactive response signalling completion.
    
    Throws:
    
    UnsupportedOperationException - If either MatchConditions.getIfMatch() or MatchConditions.getIfNoneMatch() is set.
  - listBlobs
```
public PagedFlux<BlobItem> listBlobs()
```
    Returns a reactive Publisher emitting all the blobs in this container lazily as needed. The directories are flattened and only actual blobs and no directories are returned.
    Blob names are returned in lexicographic order. For more information, see the Azure Docs.
    E.g. listing a container containing a 'foo' folder, which contains blobs 'foo1' and 'foo2', and a blob on the root level 'bar', will return
    - foo/foo1
    - foo/foo2
    - bar
    Code Samples
```
client.listBlobs().subscribe(blob ->
    System.out.printf("Name: %s, Directory? %b%n", blob.getName(), blob.isPrefix()));
```
    Returns:
    
    A reactive response emitting the flattened blobs.
  - listBlobs
```
public PagedFlux<BlobItem> listBlobs(ListBlobsOptions options)
```
    Returns a reactive Publisher emitting all the blobs in this container lazily as needed. The directories are flattened and only actual blobs and no directories are returned.
    Blob names are returned in lexicographic order. For more information, see the Azure Docs.
    E.g. listing a container containing a 'foo' folder, which contains blobs 'foo1' and 'foo2', and a blob on the root level 'bar', will return
    - foo/foo1
    - foo/foo2
    - bar
```
ListBlobsOptions options = new ListBlobsOptions()
    .setPrefix("prefixToMatch")
    .setDetails(new BlobListDetails()
        .setRetrieveDeletedBlobs(true)
        .setRetrieveSnapshots(true));

client.listBlobs(options).subscribe(blob ->
    System.out.printf("Name: %s, Directory? %b, Deleted? %b, Snapshot ID: %s%n",
        blob.getName(),
        blob.isPrefix(),
        blob.isDeleted(),
        blob.getSnapshot()));
```
    Parameters:
    
    options - ListBlobsOptions
    
    Returns:
    
    A reactive response emitting the listed blobs, flattened.
  - listBlobsByHierarchy
```
public PagedFlux<BlobItem> listBlobsByHierarchy(String directory)
```
    Returns a reactive Publisher emitting all the blobs and directories (prefixes) under the given directory (prefix). Directories will have BlobItem.isPrefix() set to true.
    Blob names are returned in lexicographic order. For more information, see the Azure Docs.
    E.g. listing a container containing a 'foo' folder, which contains blobs 'foo1' and 'foo2', and a blob on the root level 'bar', will return the following results when prefix=null:
    - foo/ (isPrefix = true)
    - bar (isPrefix = false)
    will return the following results when prefix="foo/":
    - foo/foo1 (isPrefix = false)
    - foo/foo2 (isPrefix = false)
    Code Samples
```
client.listBlobsByHierarchy("directoryName").subscribe(blob ->
    System.out.printf("Name: %s, Directory? %b%n", blob.getName(), blob.isDeleted()));
```
    Parameters:
    
    directory - The directory to list blobs underneath
    
    Returns:
    
    A reactive response emitting the prefixes and blobs.
  - listBlobsByHierarchy
```
public PagedFlux<BlobItem> listBlobsByHierarchy(String delimiter,
                                                ListBlobsOptions options)
```
    Returns a reactive Publisher emitting all the blobs and prefixes (directories) under the given prefix (directory). Directories will have BlobItem.isPrefix() set to true.
    Blob names are returned in lexicographic order. For more information, see the Azure Docs.
    E.g. listing a container containing a 'foo' folder, which contains blobs 'foo1' and 'foo2', and a blob on the root level 'bar', will return the following results when prefix=null:
    - foo/ (isPrefix = true)
    - bar (isPrefix = false)
    will return the following results when prefix="foo/":
    - foo/foo1 (isPrefix = false)
    - foo/foo2 (isPrefix = false)
    Code Samples
```
ListBlobsOptions options = new ListBlobsOptions()
    .setPrefix("directoryName")
    .setDetails(new BlobListDetails()
        .setRetrieveDeletedBlobs(true)
        .setRetrieveSnapshots(true));

client.listBlobsByHierarchy("/", options).subscribe(blob ->
    System.out.printf("Name: %s, Directory? %b, Deleted? %b, Snapshot ID: %s%n",
        blob.getName(),
        blob.isPrefix(),
        blob.isDeleted(),
        blob.getSnapshot()));
```
    Parameters:
    
    delimiter - The delimiter for blob hierarchy, "/" for hierarchy based on directories
    
    options - ListBlobsOptions
    
    Returns:
    
    A reactive response emitting the prefixes and blobs.
  - getAccountInfo
```
public Mono<StorageAccountInfo> getAccountInfo()
```
    Returns the sku name and account kind for the account. For more information, please see the Azure Docs.
    Code Samples
```
client.getAccountInfo().subscribe(response ->
    System.out.printf("Account Kind: %s, SKU: %s%n",
        response.getAccountKind(),
        response.getSkuName()));
```
    Returns:
    
    A reactive response containing the account info.
  - getAccountInfoWithResponse
```
public Mono<Response<StorageAccountInfo>> getAccountInfoWithResponse()
```
    Returns the sku name and account kind for the account. For more information, please see the Azure Docs.
    Code Samples
```
client.getAccountInfoWithResponse().subscribe(response ->
    System.out.printf("Account Kind: %s, SKU: %s%n",
        response.getValue().getAccountKind(),
        response.getValue().getSkuName()));
```
    Returns:
    
    A reactive response containing the account info.

Class BlobContainerAsyncClient

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ROOT_CONTAINER_NAME

STATIC_WEBSITE_CONTAINER_NAME

LOG_CONTAINER_NAME

Method Detail

getBlobAsyncClient

getBlobAsyncClient

getBlobContainerUrl

getBlobContainerName

getAccountName

getServiceVersion

getHttpPipeline

getCustomerProvidedKey

exists

existsWithResponse

create

createWithResponse

delete

deleteWithResponse

getProperties

getPropertiesWithResponse

setMetadata

setMetadataWithResponse

getAccessPolicy

getAccessPolicyWithResponse

setAccessPolicy

setAccessPolicyWithResponse

listBlobs

listBlobs

listBlobsByHierarchy

listBlobsByHierarchy

getAccountInfo

getAccountInfoWithResponse