你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

BlobContainerClient Class

Package:

com.azure.storage.blob

Maven Artifact:

com.azure:azure-storage-blob:12.28.1

• java.lang.Object
• • com.azure.storage.blob.BlobContainerClient

public final class BlobContainerClient

Client to a container. It may only be instantiated through a BlobContainerClientBuilder or via the method getBlobContainerClient(String containerName). This class does not hold any state about a particular container 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 BlobClient through getBlobClient(String blobName), and operations on the service are available on BlobServiceClient.

Please refer to the Azure Docs for more information on containers.

Field Summary

Modifier and Type	Field and Description
static final String	LOG_CONTAINER_NAME Special container name for the logs container in the Storage account.
static final String	ROOT_CONTAINER_NAME Special container name for the root container in the Storage account.
static final String	STATIC_WEBSITE_CONTAINER_NAME Special container name for the static website container in the Storage account.

Method Summary

Modifier and Type	Method and Description
void	create() Creates a new container within a storage account.
boolean	createIfNotExists() Creates a new container within a storage account if it does not exist.
Response<Boolean>	createIfNotExistsWithResponse(BlobContainerCreateOptions options, Duration timeout, Context context) Creates a new container within a storage account if it does not exist.
Response<Void>	createWithResponse(Map<String,String> metadata, PublicAccessType accessType, Duration timeout, Context context) Creates a new container within a storage account.
void	delete() Marks the specified container for deletion.
boolean	deleteIfExists() Marks the specified container for deletion if it exists.
Response<Boolean>	deleteIfExistsWithResponse(BlobRequestConditions requestConditions, Duration timeout, Context context) Marks the specified container for deletion if it exists.
Response<Void>	deleteWithResponse(BlobRequestConditions requestConditions, Duration timeout, Context context) Marks the specified container for deletion.
boolean	exists() Gets if the container this client represents exists in the cloud.
Response<Boolean>	existsWithResponse(Duration timeout, Context context) Gets if the container this client represents exists in the cloud.
PagedIterable<TaggedBlobItem>	findBlobsByTags(FindBlobsOptions options, Duration timeout, Context context) Returns a lazy loaded list of blobs in this account whose tags match the query expression.
PagedIterable<TaggedBlobItem>	findBlobsByTags(String query) Returns a lazy loaded list of blobs in this container whose tags match the query expression.
String	generateSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues) Generates a service SAS for the container using the specified BlobServiceSasSignatureValues
String	generateSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues, Context context) Generates a service SAS for the container using the specified BlobServiceSasSignatureValues
String	generateSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues, Consumer<String> stringToSignHandler, Context context) Generates a service SAS for the container using the specified BlobServiceSasSignatureValues
String	generateUserDelegationSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues, UserDelegationKey userDelegationKey) Generates a user delegation SAS for the container using the specified BlobServiceSasSignatureValues.
String	generateUserDelegationSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues, UserDelegationKey userDelegationKey, String accountName, Context context) Generates a user delegation SAS for the container using the specified BlobServiceSasSignatureValues.
String	generateUserDelegationSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues, UserDelegationKey userDelegationKey, String accountName, Consumer<String> stringToSignHandler, Context context) Generates a user delegation SAS for the container using the specified BlobServiceSasSignatureValues.
BlobContainerAccessPolicies	getAccessPolicy() Returns the container's permissions.
Response<BlobContainerAccessPolicies>	getAccessPolicyWithResponse(String leaseId, Duration timeout, Context context) Returns the container's permissions.
StorageAccountInfo	getAccountInfo(Duration timeout) Returns the sku name and account kind for the account.
Response<StorageAccountInfo>	getAccountInfoWithResponse(Duration timeout, Context context) Returns the sku name and account kind for the account.
String	getAccountName() Get associated account name.
String	getAccountUrl() Get the url of the storage account.
BlobClient	getBlobClient(String blobName) Initializes a new BlobClient object by concatenating blobName to the end of ContainerAsyncClient's URL.
BlobClient	getBlobClient(String blobName, String snapshot) Initializes a new BlobClient 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.
BlobClient	getBlobVersionClient(String blobName, String versionId) Initializes a new BlobClient object by concatenating blobName to the end of ContainerAsyncClient's URL.
CpkInfo	getCustomerProvidedKey() Gets the CpkInfo associated with this client that will be passed to BlobClient when getBlobClient(String blobName) is called.
String	getEncryptionScope() Gets the encryption scope used to encrypt this blob's content on the server.
HttpPipeline	getHttpPipeline() Gets the HttpPipeline powering this client.
BlobContainerProperties	getProperties() Returns the container's metadata and system properties.
Response<BlobContainerProperties>	getPropertiesWithResponse(String leaseId, Duration timeout, Context context) Returns the container's metadata and system properties.
BlobServiceClient	getServiceClient() Get a client pointing to the account.
BlobServiceVersion	getServiceVersion() Gets the service version the client is using.
PagedIterable<BlobItem>	listBlobs() Returns a lazy loaded list of blobs in this container, with folder structures flattened.
PagedIterable<BlobItem>	listBlobs(ListBlobsOptions options, String continuationToken, Duration timeout) Returns a lazy loaded list of blobs in this container, with folder structures flattened.
PagedIterable<BlobItem>	listBlobs(ListBlobsOptions options, Duration timeout) Returns a lazy loaded list of blobs in this container, with folder structures flattened.
PagedIterable<BlobItem>	listBlobsByHierarchy(String directory) Returns a reactive Publisher emitting all the blobs and directories (prefixes) under the given directory (prefix).
PagedIterable<BlobItem>	listBlobsByHierarchy(String delimiter, ListBlobsOptions options, Duration timeout) Returns a reactive Publisher emitting all the blobs and prefixes (directories) under the given prefix (directory).
void	setAccessPolicy(PublicAccessType accessType, List<BlobSignedIdentifier> identifiers) Sets the container's permissions.
Response<Void>	setAccessPolicyWithResponse(PublicAccessType accessType, List<BlobSignedIdentifier> identifiers, BlobRequestConditions requestConditions, Duration timeout, Context context) Sets the container's permissions.
void	setMetadata(Map<String,String> metadata) Sets the container's metadata.
Response<Void>	setMetadataWithResponse(Map<String,String> metadata, BlobRequestConditions requestConditions, Duration timeout, Context context) Sets the container's metadata.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Details

LOG_CONTAINER_NAME

public static final String LOG_CONTAINER_NAME

Special container name for the logs container in the Storage account.

ROOT_CONTAINER_NAME

public static final String ROOT_CONTAINER_NAME

Special container name for the root container in the Storage account.

STATIC_WEBSITE_CONTAINER_NAME

public static final String STATIC_WEBSITE_CONTAINER_NAME

Special container name for the static website container in the Storage account.

Method Details

create

public 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

try {
     client.create();
     System.out.printf("Create completed%n");
 } catch (BlobStorageException error) {
     if (error.getErrorCode().equals(BlobErrorCode.CONTAINER_ALREADY_EXISTS)) {
         System.out.printf("Can't create container. It already exists %n");
     }
 }

createIfNotExists

public boolean createIfNotExists()

Creates a new container within a storage account if it does not exist. For more information, see the Azure Docs.

Code Samples

boolean result = client.createIfNotExists();
 System.out.println("Create completed: " + result);

Returns:

true if container is successfully created, false if container already exists.

createIfNotExistsWithResponse

public Response createIfNotExistsWithResponse(BlobContainerCreateOptions options, Duration timeout, Context context)

Creates a new container within a storage account if it does not exist. For more information, see the Azure Docs.

Code Samples

Map<String, String> metadata = Collections.singletonMap("metadata", "value");
 Context context = new Context("Key", "Value");
 BlobContainerCreateOptions options = new BlobContainerCreateOptions().setMetadata(metadata)
     .setPublicAccessType(PublicAccessType.CONTAINER);

 Response<Boolean> response = client.createIfNotExistsWithResponse(options, timeout, context);
 if (response.getStatusCode() == 409) {
     System.out.println("Already existed.");
 } else {
     System.out.printf("Create completed with status %d%n", response.getStatusCode());
 }

Parameters:

options - BlobContainerCreateOptions

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

A response containing status code and HTTP headers. If Response<T>'s status code is 201, a new container was successfully created. If status code is 409, a container already existed at this location.

createWithResponse

public Response createWithResponse(Map metadata, PublicAccessType accessType, Duration timeout, Context context)

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");
 Context context = new Context("Key", "Value");

 System.out.printf("Create completed with status %d%n",
     client.createWithResponse(metadata, PublicAccessType.CONTAINER, timeout, context).getStatusCode());

Parameters:

metadata - Metadata to associate with the container. If there is leading or trailing whitespace in any metadata key or value, it must be removed or encoded.

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.

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

A response containing status code and HTTP headers

delete

public 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

try {
     client.delete();
     System.out.printf("Delete completed%n");
 } catch (BlobStorageException error) {
     if (error.getErrorCode().equals(BlobErrorCode.CONTAINER_NOT_FOUND)) {
         System.out.printf("Delete failed. Container was not found %n");
     }
 }

deleteIfExists

public boolean deleteIfExists()

Marks the specified container for deletion if it exists. The container and any blobs contained within it are later deleted during garbage collection. For more information, see the Azure Docs.

Code Samples

boolean result = client.deleteIfExists();
 System.out.println("Delete completed: " + result);

Returns:

true if container is successfully deleted, false if container does not exist.

deleteIfExistsWithResponse

public Response deleteIfExistsWithResponse(BlobRequestConditions requestConditions, Duration timeout, Context context)

Marks the specified container for deletion if it exists. The container and any blobs contained within it are later deleted during garbage collection. For more information, see the Azure Docs.

Code Samples

BlobRequestConditions requestConditions = new BlobRequestConditions()
     .setLeaseId(leaseId)
     .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));
 Context context = new Context("Key", "Value");

 Response<Boolean> response = client.deleteIfExistsWithResponse(requestConditions, timeout, context);
 if (response.getStatusCode() == 404) {
     System.out.println("Does not exist.");
 } else {
     System.out.printf("Delete completed with status %d%n", response.getStatusCode());
 }

Parameters:

requestConditions - BlobRequestConditions

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

A response containing status code and HTTP headers. If Response<T>'s status code is 202, the container was successfully deleted. If status code is 404, the container does not exist.

deleteWithResponse

public Response deleteWithResponse(BlobRequestConditions requestConditions, Duration timeout, Context context)

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 requestConditions = new BlobRequestConditions()
     .setLeaseId(leaseId)
     .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));
 Context context = new Context("Key", "Value");

 System.out.printf("Delete completed with status %d%n", client.deleteWithResponse(
     requestConditions, timeout, context).getStatusCode());

Parameters:

requestConditions - BlobRequestConditions

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

A response containing status code and HTTP headers

exists

public boolean exists()

Gets if the container this client represents exists in the cloud.

Code Samples

System.out.printf("Exists? %b%n", client.exists());

Returns:

true if the container exists, false if it doesn't

existsWithResponse

public Response existsWithResponse(Duration timeout, Context context)

Gets if the container this client represents exists in the cloud.

Code Samples

Context context = new Context("Key", "Value");
 System.out.printf("Exists? %b%n", client.existsWithResponse(timeout, context).getValue());

Parameters:

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

true if the container exists, false if it doesn't

findBlobsByTags

public PagedIterable findBlobsByTags(FindBlobsOptions options, Duration timeout, Context context)

Returns a lazy loaded list of blobs in this account whose tags match the query expression. The returned PagedIterable<T> can be consumed while new items are automatically retrieved as needed. For more information, including information on the query syntax, see the Azure Docs.

Code Samples

Context context = new Context("Key", "Value");
 client.findBlobsByTags(new FindBlobsOptions("where=tag=value").setMaxResultsPerPage(10), timeout, context)
     .forEach(blob -> System.out.printf("Name: %s%n", blob.getName()));

Parameters:

options - FindBlobsOptions. If iterating by page, the page size passed to byPage methods such as PagedIterable#iterableByPage(int) will be preferred over the value set on these options.

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

The list of blobs.

findBlobsByTags

public PagedIterable findBlobsByTags(String query)

Returns a lazy loaded list of blobs in this container whose tags match the query expression. The returned PagedIterable<T> can be consumed while new items are automatically retrieved as needed. For more information, including information on the query syntax, see the Azure Docs.

Code Samples

TODO

client.findBlobsByTags("where=tag=value").forEach(blob -> System.out.printf("Name: %s%n", blob.getName()));

Parameters:

query - Filters the results to return only blobs whose tags match the specified expression.

Returns:

The list of blobs.

generateSas

public String generateSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues)

Generates a service SAS for the container using the specified BlobServiceSasSignatureValues

Note : The client must be authenticated via StorageSharedKeyCredential

See BlobServiceSasSignatureValues for more information on how to construct a service SAS.

Code Samples

OffsetDateTime expiryTime = OffsetDateTime.now().plusDays(1);
 BlobContainerSasPermission permission = new BlobContainerSasPermission().setReadPermission(true);

 BlobServiceSasSignatureValues values = new BlobServiceSasSignatureValues(expiryTime, permission)
     .setStartTime(OffsetDateTime.now());

 client.generateSas(values); // Client must be authenticated via StorageSharedKeyCredential

Parameters:

blobServiceSasSignatureValues - BlobServiceSasSignatureValues

Returns:

A String representing the SAS query parameters.

generateSas

public String generateSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues, Context context)

Generates a service SAS for the container using the specified BlobServiceSasSignatureValues

Note : The client must be authenticated via StorageSharedKeyCredential

See BlobServiceSasSignatureValues for more information on how to construct a service SAS.

Code Samples

OffsetDateTime expiryTime = OffsetDateTime.now().plusDays(1);
 BlobContainerSasPermission permission = new BlobContainerSasPermission().setReadPermission(true);

 BlobServiceSasSignatureValues values = new BlobServiceSasSignatureValues(expiryTime, permission)
     .setStartTime(OffsetDateTime.now());

 // Client must be authenticated via StorageSharedKeyCredential
 client.generateSas(values, new Context("key", "value"));

Parameters:

blobServiceSasSignatureValues - BlobServiceSasSignatureValues

context - Additional context that is passed through the code when generating a SAS.

Returns:

A String representing the SAS query parameters.

generateSas

public String generateSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues, Consumer stringToSignHandler, Context context)

Generates a service SAS for the container using the specified BlobServiceSasSignatureValues

Note : The client must be authenticated via StorageSharedKeyCredential

See BlobServiceSasSignatureValues for more information on how to construct a service SAS.

Parameters:

blobServiceSasSignatureValues - BlobServiceSasSignatureValues

stringToSignHandler - For debugging purposes only. Returns the string to sign that was used to generate the signature.

context - Additional context that is passed through the code when generating a SAS.

Returns:

A String representing the SAS query parameters.

generateUserDelegationSas

public String generateUserDelegationSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues, UserDelegationKey userDelegationKey)

Generates a user delegation SAS for the container using the specified BlobServiceSasSignatureValues.

See BlobServiceSasSignatureValues for more information on how to construct a user delegation SAS.

Code Samples

OffsetDateTime myExpiryTime = OffsetDateTime.now().plusDays(1);
 BlobContainerSasPermission myPermission = new BlobContainerSasPermission().setReadPermission(true);

 BlobServiceSasSignatureValues myValues = new BlobServiceSasSignatureValues(expiryTime, permission)
     .setStartTime(OffsetDateTime.now());

 client.generateUserDelegationSas(values, userDelegationKey);

Parameters:

blobServiceSasSignatureValues - BlobServiceSasSignatureValues

userDelegationKey - A UserDelegationKey object used to sign the SAS values. See getUserDelegationKey(OffsetDateTime start, OffsetDateTime expiry) for more information on how to get a user delegation key.

Returns:

A String representing the SAS query parameters.

generateUserDelegationSas

public String generateUserDelegationSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues, UserDelegationKey userDelegationKey, String accountName, Context context)

Generates a user delegation SAS for the container using the specified BlobServiceSasSignatureValues.

See BlobServiceSasSignatureValues for more information on how to construct a user delegation SAS.

Code Samples

OffsetDateTime myExpiryTime = OffsetDateTime.now().plusDays(1);
 BlobContainerSasPermission myPermission = new BlobContainerSasPermission().setReadPermission(true);

 BlobServiceSasSignatureValues myValues = new BlobServiceSasSignatureValues(expiryTime, permission)
     .setStartTime(OffsetDateTime.now());

 client.generateUserDelegationSas(values, userDelegationKey, accountName, new Context("key", "value"));

Parameters:

blobServiceSasSignatureValues - BlobServiceSasSignatureValues

userDelegationKey - A UserDelegationKey object used to sign the SAS values. See getUserDelegationKey(OffsetDateTime start, OffsetDateTime expiry) for more information on how to get a user delegation key..

accountName - The account name.

context - Additional context that is passed through the code when generating a SAS.

Returns:

A String representing the SAS query parameters.

generateUserDelegationSas

public String generateUserDelegationSas(BlobServiceSasSignatureValues blobServiceSasSignatureValues, UserDelegationKey userDelegationKey, String accountName, Consumer stringToSignHandler, Context context)

Generates a user delegation SAS for the container using the specified BlobServiceSasSignatureValues.

See BlobServiceSasSignatureValues for more information on how to construct a user delegation SAS.

Parameters:

blobServiceSasSignatureValues - BlobServiceSasSignatureValues

userDelegationKey - A UserDelegationKey object used to sign the SAS values. See getUserDelegationKey(OffsetDateTime start, OffsetDateTime expiry) for more information on how to get a user delegation key..

accountName - The account name.

stringToSignHandler - For debugging purposes only. Returns the string to sign that was used to generate the signature.

context - Additional context that is passed through the code when generating a SAS.

Returns:

A String representing the SAS query parameters.

getAccessPolicy

public 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

BlobContainerAccessPolicies accessPolicies = client.getAccessPolicy();
 System.out.printf("Blob Access Type: %s%n", accessPolicies.getBlobAccessType());

 for (BlobSignedIdentifier identifier : accessPolicies.getIdentifiers()) {
     System.out.printf("Identifier Name: %s, Permissions %s%n",
         identifier.getId(),
         identifier.getAccessPolicy().getPermissions());
 }

Returns:

The container access policy.

getAccessPolicyWithResponse

public Response getAccessPolicyWithResponse(String leaseId, Duration timeout, Context context)

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

Context context = new Context("Key", "Value");
 BlobContainerAccessPolicies accessPolicies = client.getAccessPolicyWithResponse(leaseId, timeout, context)
     .getValue();
 System.out.printf("Blob Access Type: %s%n", accessPolicies.getBlobAccessType());

 for (BlobSignedIdentifier identifier : accessPolicies.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.

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

The container access policy.

getAccountInfo

public StorageAccountInfo getAccountInfo(Duration timeout)

Returns the sku name and account kind for the account. For more information, please see the Azure Docs.

Parameters:

timeout - An optional timeout value beyond which a RuntimeException will be raised. Code Samples

 StorageAccountInfo accountInfo = client.getAccountInfo(timeout);
 System.out.printf("Account Kind: %s, SKU: %s%n", accountInfo.getAccountKind(), accountInfo.getSkuName());
 

Returns:

The account info.

getAccountInfoWithResponse

public Response getAccountInfoWithResponse(Duration timeout, Context context)

Returns the sku name and account kind for the account. For more information, please see the Azure Docs.

Code Samples

Context context = new Context("Key", "Value");
 StorageAccountInfo accountInfo = client.getAccountInfoWithResponse(timeout, context).getValue();
 System.out.printf("Account Kind: %s, SKU: %s%n", accountInfo.getAccountKind(), accountInfo.getSkuName());

Parameters:

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

The account info.

getAccountName

public String getAccountName()

Get associated account name.

Returns:

account name associated with this storage resource.

getAccountUrl

public String getAccountUrl()

Get the url of the storage account.

Returns:

the URL of the storage account

getBlobClient

public BlobClient getBlobClient(String blobName)

Initializes a new BlobClient object by concatenating blobName to the end of ContainerAsyncClient's URL. The new BlobClient uses the same request policy pipeline as the ContainerAsyncClient.

Parameters:

blobName - A String representing the name of the blob. If the blob name contains special characters, pass in the url encoded version of the blob name. Code Samples

 BlobClient blobClient = client.getBlobClient(blobName);
 

Returns:

A new BlobClient object which references the blob with the specified name in this container.

getBlobClient

public BlobClient getBlobClient(String blobName, String snapshot)

Initializes a new BlobClient object by concatenating blobName to the end of ContainerAsyncClient's URL. The new BlobClient uses the same request policy pipeline as the ContainerAsyncClient.

Code Samples

BlobClient blobClient = client.getBlobClient(blobName, snapshot);

Parameters:

blobName - A String representing the name of the blob. If the blob name contains special characters, pass in the url encoded version of the blob name.

snapshot - the snapshot identifier for the blob.

Returns:

A new BlobClient object which references the blob with the specified name in this container.

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.

getBlobContainerUrl

public String getBlobContainerUrl()

Gets the URL of the container represented by this client.

Returns:

the URL.

getBlobVersionClient

public BlobClient getBlobVersionClient(String blobName, String versionId)

Initializes a new BlobClient object by concatenating blobName to the end of ContainerAsyncClient's URL. The new BlobClient uses the same request policy pipeline as the ContainerAsyncClient.

Parameters:

blobName - A String representing the name of the blob. If the blob name contains special characters, pass in the url encoded version of the blob name.

versionId - the version identifier for the blob, pass null to interact with the latest blob version.

Returns:

A new BlobClient object which references the blob with the specified name in this container.

getCustomerProvidedKey

public CpkInfo getCustomerProvidedKey()

Gets the CpkInfo associated with this client that will be passed to BlobClient when getBlobClient(String blobName) is called.

Returns:

the customer provided key used for encryption.

getEncryptionScope

public String getEncryptionScope()

Gets the encryption scope used to encrypt this blob's content on the server.

Returns:

the encryption scope used for encryption.

getHttpPipeline

public HttpPipeline getHttpPipeline()

Gets the HttpPipeline powering this client.

Returns:

The pipeline.

getProperties

public BlobContainerProperties getProperties()

Returns the container's metadata and system properties. For more information, see the Azure Docs.

Code Samples

BlobContainerProperties properties = client.getProperties();
 System.out.printf("Public Access Type: %s, Legal Hold? %b, Immutable? %b%n",
     properties.getBlobPublicAccess(),
     properties.hasLegalHold(),
     properties.hasImmutabilityPolicy());

Returns:

The container properties.

getPropertiesWithResponse

public Response getPropertiesWithResponse(String leaseId, Duration timeout, Context context)

Returns the container's metadata and system properties. For more information, see the Azure Docs.

Code Samples

Context context = new Context("Key", "Value");

 BlobContainerProperties properties = client.getPropertiesWithResponse(leaseId, timeout, context)
     .getValue();
 System.out.printf("Public Access Type: %s, Legal Hold? %b, Immutable? %b%n",
     properties.getBlobPublicAccess(),
     properties.hasLegalHold(),
     properties.hasImmutabilityPolicy());

Parameters:

leaseId - The lease ID the active lease on the container must match.

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

The container properties.

getServiceClient

public BlobServiceClient getServiceClient()

Get a client pointing to the account.

Returns:

BlobServiceClient

getServiceVersion

public BlobServiceVersion getServiceVersion()

Gets the service version the client is using.

Returns:

the service version the client is using.

listBlobs

public PagedIterable listBlobs()

Returns a lazy loaded list of blobs in this container, with folder structures flattened. The returned PagedIterable<T> can be consumed through while new items are automatically retrieved as needed.

Blob names are returned in lexicographic order.

For more information, see the Azure Docs.

Code Samples

client.listBlobs().forEach(blob ->
     System.out.printf("Name: %s, Directory? %b%n", blob.getName(), blob.isPrefix()));

Returns:

The listed blobs, flattened.

listBlobs

public PagedIterable listBlobs(ListBlobsOptions options, String continuationToken, Duration timeout)

Returns a lazy loaded list of blobs in this container, with folder structures flattened. The returned PagedIterable<T> can be consumed through while new items are automatically retrieved as needed.

Blob names are returned in lexicographic order.

For more information, see the Azure Docs.

Code Samples

ListBlobsOptions options = new ListBlobsOptions()
     .setPrefix("prefixToMatch")
     .setDetails(new BlobListDetails()
         .setRetrieveDeletedBlobs(true)
         .setRetrieveSnapshots(true));

 String continuationToken = "continuationToken";

 client.listBlobs(options, continuationToken, timeout).forEach(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. If iterating by page, the page size passed to byPage methods such as PagedIterable#iterableByPage(int) will be preferred over the value set on these options.

continuationToken - Identifies the portion of the list to be returned with the next list operation.

timeout - An optional timeout value beyond which a RuntimeException will be raised.

Returns:

The listed blobs, flattened.

listBlobs

public PagedIterable listBlobs(ListBlobsOptions options, Duration timeout)

Returns a lazy loaded list of blobs in this container, with folder structures flattened. The returned PagedIterable<T> can be consumed through while new items are automatically retrieved as needed.

Blob names are returned in lexicographic order.

For more information, see the Azure Docs.

Code Samples

ListBlobsOptions options = new ListBlobsOptions()
     .setPrefix("prefixToMatch")
     .setDetails(new BlobListDetails()
         .setRetrieveDeletedBlobs(true)
         .setRetrieveSnapshots(true));

 client.listBlobs(options, timeout).forEach(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. If iterating by page, the page size passed to byPage methods such as PagedIterable#iterableByPage(int) will be preferred over the value set on these options.

timeout - An optional timeout value beyond which a RuntimeException will be raised.

Returns:

The listed blobs, flattened.

listBlobsByHierarchy

public PagedIterable listBlobsByHierarchy(String directory)

Returns a reactive Publisher emitting all the blobs and directories (prefixes) under the given directory (prefix). Directories will have 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").forEach(blob ->
     System.out.printf("Name: %s, Directory? %b%n", blob.getName(), blob.isPrefix()));

Parameters:

directory - The directory to list blobs underneath

Returns:

A reactive response emitting the prefixes and blobs.

listBlobsByHierarchy

public PagedIterable listBlobsByHierarchy(String delimiter, ListBlobsOptions options, Duration timeout)

Returns a reactive Publisher emitting all the blobs and prefixes (directories) under the given prefix (directory). Directories will have 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(false));

 client.listBlobsByHierarchy("/", options, timeout).forEach(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. If iterating by page, the page size passed to byPage methods such as PagedIterable#iterableByPage(int) will be preferred over the value set on these options.

timeout - An optional timeout value beyond which a RuntimeException will be raised.

Returns:

A reactive response emitting the prefixes and blobs.

setAccessPolicy

public void setAccessPolicy(PublicAccessType accessType, List 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"));

 try {
     client.setAccessPolicy(PublicAccessType.CONTAINER, Collections.singletonList(identifier));
     System.out.printf("Set Access Policy completed %n");
 } catch (UnsupportedOperationException error) {
     System.out.printf("Set Access Policy completed %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.

setAccessPolicyWithResponse

public Response setAccessPolicyWithResponse(PublicAccessType accessType, List identifiers, BlobRequestConditions requestConditions, Duration timeout, Context context)

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 requestConditions = new BlobRequestConditions()
     .setLeaseId(leaseId)
     .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));

 Context context = new Context("Key", "Value");

 System.out.printf("Set access policy completed with status %d%n",
     client.setAccessPolicyWithResponse(PublicAccessType.CONTAINER,
         Collections.singletonList(identifier),
         requestConditions,
         timeout,
         context).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.

requestConditions - BlobRequestConditions

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

A response containing status code and HTTP headers

setMetadata

public void setMetadata(Map metadata)

Sets the container's metadata. For more information, see the Azure Docs.

Code Samples

Map<String, String> metadata = Collections.singletonMap("metadata", "value");
 try {
     client.setMetadata(metadata);
     System.out.printf("Set metadata completed with status %n");
 } catch (UnsupportedOperationException error) {
     System.out.printf("Fail while setting metadata %n");
 }

Parameters:

metadata - Metadata to associate with the container. If there is leading or trailing whitespace in any metadata key or value, it must be removed or encoded.

setMetadataWithResponse

public Response setMetadataWithResponse(Map metadata, BlobRequestConditions requestConditions, Duration timeout, Context context)

Sets the container's metadata. For more information, see the Azure Docs.

Code Samples

Map<String, String> metadata = Collections.singletonMap("metadata", "value");
 BlobRequestConditions requestConditions = new BlobRequestConditions()
     .setLeaseId(leaseId)
     .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));
 Context context = new Context("Key", "Value");

 System.out.printf("Set metadata completed with status %d%n",
     client.setMetadataWithResponse(metadata, requestConditions, timeout, context).getStatusCode());

Parameters:

metadata - Metadata to associate with the container. If there is leading or trailing whitespace in any metadata key or value, it must be removed or encoded.

requestConditions - BlobRequestConditions

timeout - An optional timeout value beyond which a RuntimeException will be raised.

context - Additional context that is passed through the Http pipeline during the service call.

Returns:

A response containing status code and HTTP headers