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

CloudBlobContainer 类

包:

com.microsoft.azure.storage.blob

• java.lang.Object
• • com.microsoft.azure.storage.blob.CloudBlobContainer

public class CloudBlobContainer

表示 Microsoft Azure Blob 服务中的容器。

容器，封装为 CloudBlobDirectory 对象，其中包含目录，目录中包含块 Blob 和页 Blob。 目录还可以包含子目录。

字段摘要

修饰符和类型	字段和描述
HashMap<String, String>	metadata 表示容器元数据。

构造函数摘要

构造函数	说明
CloudBlobContainer(final StorageUri storageUri)	使用指定的 URI 创建 类的实例。 Blob URI 应包含 SAS 令牌，除非使用匿名访问。
CloudBlobContainer(final StorageUri storageUri, final StorageCredentials credentials)	使用指定的 StorageUri 和凭据创建 类的实例。
CloudBlobContainer(final String containerName, final CloudBlobClient client)	使用指定的名称和客户端创建 类的实例。
CloudBlobContainer(final URI uri)	使用指定的 URI 创建 类的实例。 Blob URI 应包含 SAS 令牌，除非使用匿名访问。
CloudBlobContainer(final URI uri, final StorageCredentials credentials)	使用指定的 URI 和凭据创建 类的实例。

方法摘要

修饰符和类型	方法和描述
final String	acquireLease() 获取容器上的新无限租约。
final String	acquireLease(final Integer leaseTimeInSeconds, final String proposedLeaseId) 获取具有指定租用时间和建议租约 ID 的容器上的新租约。
final String	acquireLease(final Integer leaseTimeInSeconds, final String proposedLeaseId, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) 获取具有指定租用时间、建议的租约 ID、请求选项和操作上下文的容器上的新租约。
final long	breakLease(final Integer breakPeriodInSeconds) 中断租约，并确保其他客户端在当前租约期到期之前无法获取新租约。
final long	breakLease(final Integer breakPeriodInSeconds, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) 使用指定的请求选项和操作上下文中断现有租约，并确保在当前租约期到期之前，其他客户端无法获取新的租约。
final String	changeLease(final String proposedLeaseId, final AccessCondition accessCondition) 将现有租约 ID 更改为建议的租约 ID。
final String	changeLease(final String proposedLeaseId, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) 使用指定的访问条件、请求选项和操作上下文将现有租约 ID 更改为建议的租约 ID。
void	create() 创建容器。
void	create(BlobContainerPublicAccessType accessType, BlobRequestOptions options, OperationContext opContext) 使用指定的选项和操作上下文创建容器。
void	create(BlobRequestOptions options, OperationContext opContext) 使用指定的选项和操作上下文创建容器。
boolean	createIfNotExists() 如果容器不存在，则创建该容器。
boolean	createIfNotExists(BlobContainerPublicAccessType accessType, BlobRequestOptions options, OperationContext opContext) 使用指定的请求选项和操作上下文创建容器（如果不存在）。
boolean	createIfNotExists(BlobRequestOptions options, OperationContext opContext) 使用指定的请求选项和操作上下文创建容器（如果不存在）。
void	delete() 删除容器。
void	delete(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) 使用指定的请求选项和操作上下文删除容器。
boolean	deleteIfExists() 删除容器（如果存在）。
boolean	deleteIfExists(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) 使用指定的请求选项和操作上下文删除容器（如果存在）。
AccountInformation	downloadAccountInfo() 获取与此容器所在的存储帐户相关的信息。
AccountInformation	downloadAccountInfo(BlobRequestOptions options, OperationContext opContext) 获取与此容器所在的存储帐户相关的信息。
StorageRequest<ServiceClient, CloudBlobContainer, AccountInformation>	downloadAccountInformationImpl(final RequestOptions options)
void	downloadAttributes() 下载容器的属性，这些属性由元数据和属性组成。
void	downloadAttributes(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) 使用指定的请求选项和操作上下文下载容器的属性，其中包括元数据和属性。
BlobContainerPermissions	downloadPermissions() 下载容器的权限设置。
BlobContainerPermissions	downloadPermissions(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) 使用指定的请求选项和操作上下文下载容器的权限设置。
boolean	exists() 返回一个值，该值指示容器是否存在。
boolean	exists(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) 使用指定的请求选项和操作上下文返回一个值，该值指示容器是否存在。
String	generateSharedAccessSignature(final SharedAccessBlobPolicy policy, final String groupPolicyIdentifier) 返回容器的共享访问签名。 请注意，这不包含前导“？”。
String	generateSharedAccessSignature(final SharedAccessBlobPolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols) 返回容器的共享访问签名。 请注意，这不包含前导“？”。
CloudAppendBlob	getAppendBlobReference(final String blobName) 返回对 CloudAppendBlob 对象的引用，该对象表示此容器中的追加 Blob。
CloudAppendBlob	getAppendBlobReference(final String blobName, final String snapshotID) 使用指定的快照 ID，返回对 CloudAppendBlob 表示容器中追加 blob 的 对象的引用。
final CloudBlob	getBlobReferenceFromServer(final String blobName) 获取对此容器中的 Blob 的引用。 Blob 必须已存在于服务中。 与其他 get*Reference 方法不同，此方法执行服务请求来检索 Blob 的元数据和属性。 返回的 Blob 可以直接用作 CloudBlob，也可以使用 instanceof 或 getProperties () .getBlobType () 进行强制转换，以确定其子类型。
final CloudBlob	getBlobReferenceFromServer(final String blobName, final String snapshotID, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) 获取对此容器中的 Blob 的引用。 Blob 必须已存在于服务中。 与其他 get*Reference 方法不同，此方法执行服务请求来检索 Blob 的元数据和属性。 返回的 Blob 可以直接用作 CloudBlob，也可以使用 instanceof 或 getProperties () .getBlobType () 进行强制转换，以确定其子类型。
CloudBlockBlob	getBlockBlobReference(final String blobName) 返回对 CloudBlockBlob 表示此容器中的块 Blob 的 对象的引用。
CloudBlockBlob	getBlockBlobReference(final String blobName, final String snapshotID) 使用指定的快照 ID 返回对CloudBlockBlob表示此容器中的块 Blob 的 对象的引用。
CloudBlobDirectory	getDirectoryReference(String directoryName) 返回对 CloudBlobDirectory 对象的引用，该对象表示此容器中的虚拟 Blob 目录。
HashMap<String, String>	getMetadata() 返回容器的元数据。 此值通过调用 downloadAttributes()，使用队列中的元数据进行初始化，并且通过调用 uploadMetadata()在队列上设置此值。
String	getName() 返回容器的名称。
CloudPageBlob	getPageBlobReference(final String blobName) 返回对 CloudPageBlob 表示此容器中的页 Blob 的 对象的引用。
CloudPageBlob	getPageBlobReference(final String blobName, final String snapshotID) 使用指定的快照 ID 返回对 CloudPageBlob 表示容器中页 Blob 的 对象的引用。
BlobContainerProperties	getProperties() 返回容器的属性。
CloudBlobClient	getServiceClient() 返回与此容器关联的 Blob 服务客户端。
StorageUri	getStorageUri() 返回所有位置的 URI 列表。
URI	getUri() 返回此容器的 URI。
Iterable<ListBlobItem>	listBlobs() 返回容器的 Blob 项的可枚举集合。
Iterable<ListBlobItem>	listBlobs(final String prefix) 返回容器的 Blob 项的可枚举集合，其名称以指定前缀开头。
Iterable<ListBlobItem>	listBlobs(final String prefix, final boolean useFlatBlobListing) 返回容器的 Blob 项的可枚举集合，该容器的名称使用指定的平面或分层选项以指定前缀开头。
Iterable<ListBlobItem>	listBlobs(final String prefix, final boolean useFlatBlobListing, final EnumSet<BlobListingDetails> listingDetails, BlobRequestOptions options, OperationContext opContext) 返回容器的 Blob 项的可枚举集合，该容器的名称以指定前缀开头，使用指定的平面或分层选项、列出详细信息选项、请求选项和操作上下文。
ResultSegment<ListBlobItem>	listBlobsSegmented() 返回容器中 Blob 项的可枚举集合的结果段。
ResultSegment<ListBlobItem>	listBlobsSegmented(final String prefix) 返回一个结果段，其中包含其名称以指定前缀开头的 blob 项集合。
ResultSegment<ListBlobItem>	listBlobsSegmented(final String prefix, final boolean useFlatBlobListing, final EnumSet<BlobListingDetails> listingDetails, final Integer maxResults, final ResultContinuation continuationToken, BlobRequestOptions options, OperationContext opContext) 返回一个结果段，其中包含名称以指定前缀开头、使用指定的平面或分层选项、列出详细信息选项、请求选项和操作上下文的 blob 项集合。
Iterable<CloudBlobContainer>	listContainers() 返回与此容器关联的服务客户端的容器的可枚举集合。
Iterable<CloudBlobContainer>	listContainers(final String prefix) 返回容器的可枚举集合，其名称以与此容器关联的服务客户端的指定前缀开头。
Iterable<CloudBlobContainer>	listContainers(final String prefix, final ContainerListingDetails detailsIncluded, final BlobRequestOptions options, final OperationContext opContext) 使用指定的详细信息设置、请求选项和操作上下文返回容器的可枚举集合，其名称以与此容器关联的服务客户端的指定前缀开头。
ResultSegment<CloudBlobContainer>	listContainersSegmented() 返回与此容器关联的服务客户端的可枚举容器集合的结果段。
ResultSegment<CloudBlobContainer>	listContainersSegmented(final String prefix) 返回容器的可枚举集合的结果段，其名称以与此容器关联的服务客户端的指定前缀开头。
ResultSegment<CloudBlobContainer>	listContainersSegmented(final String prefix, final ContainerListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final BlobRequestOptions options, final OperationContext opContext) 使用指定的列表详细信息选项、请求选项和操作上下文返回包含容器集合的结果段，这些容器的名称以与此容器关联的服务客户端的指定前缀开头。
final void	releaseLease(final AccessCondition accessCondition) 释放容器上的租约。
final void	releaseLease(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) 使用指定的访问条件、请求选项和操作上下文释放容器上的租约。
final void	renewLease(final AccessCondition accessCondition) 使用指定的访问条件续订现有租约。
final void	renewLease(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) 使用指定的访问条件、请求选项和操作上下文续订现有租约。
void	setMetadata(final HashMap<String, String> metadata) 通过调用设置要在容器 uploadMetadata() 上设置的名称/值对的元数据集合。 此集合将覆盖任何现有容器元数据。 如果将其设置为空集合，则会在调用时 uploadMetadata() 清除容器元数据。
void	setProperties(final BlobContainerProperties properties) 设置容器的属性。
void	setStorageUri(final StorageUri storageUri) 设置所有位置的 URI 列表。
void	uploadMetadata() 上传容器的元数据。
void	uploadMetadata(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) 使用指定的请求选项和操作上下文上传容器的元数据。
void	uploadPermissions(final BlobContainerPermissions permissions) 上传容器的权限。
void	uploadPermissions(final BlobContainerPermissions permissions, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext) 使用指定的请求选项和操作上下文上传容器的权限。

字段详细信息

metadata

protected HashMap metadata= new HashMap()

表示容器元数据。

构造函数详细信息

CloudBlobContainer

public CloudBlobContainer(final StorageUri storageUri)

使用指定的 URI 创建 类的实例。 Blob URI 应包含 SAS 令牌，除非使用匿名访问。

Parameters:

storageUri - 一个 StorageUri 对象，表示容器的 URI。

Throws:

StorageException - 如果发生存储服务错误。

CloudBlobContainer

public CloudBlobContainer(final StorageUri storageUri, final StorageCredentials credentials)

使用指定的 StorageUri 和凭据创建 类的实例。

Parameters:

storageUri - 一个 StorageUri 对象，表示容器的绝对 StorageUri。

credentials - StorageCredentials用于对访问进行身份验证的对象。

Throws:

StorageException - 如果发生存储服务错误。

CloudBlobContainer

protected CloudBlobContainer(final String containerName, final CloudBlobClient client)

使用指定的名称和客户端创建 类的实例。

Parameters:

containerName - 一个 String ，它表示容器的名称，该名称必须遵守容器命名规则。 容器名称不应包含 /) (的任何路径分隔符。 容器名称必须为小写，长度在 3-63 个字符之间，并且必须以字母或数字开头。 容器名称只能包含字母、数字和短划线 ( ) 字符。

client - 一个 CloudBlobClient 对象，表示关联的服务客户端，指定 Blob 服务的终结点。 *

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException - 如果基于 containerName 构造的资源 URI 无效。

CloudBlobContainer

public CloudBlobContainer(final URI uri)

使用指定的 URI 创建 类的实例。 Blob URI 应包含 SAS 令牌，除非使用匿名访问。

Parameters:

uri - 一个 java.net.URI 对象，表示容器的 URI。

Throws:

StorageException - 如果发生存储服务错误。

CloudBlobContainer

public CloudBlobContainer(final URI uri, final StorageCredentials credentials)

使用指定的 URI 和凭据创建 类的实例。

Parameters:

uri - 一个 java.net.URI 对象，表示容器的绝对 URI。

credentials - StorageCredentials用于对访问进行身份验证的对象。

Throws:

StorageException - 如果发生存储服务错误。

方法详细信息

acquireLease

public final String acquireLease()

获取容器上的新无限租约。

Returns:

表示 String 租约 ID 的 。

Throws:

StorageException - 如果发生存储服务错误。

acquireLease

public final String acquireLease(final Integer leaseTimeInSeconds, final String proposedLeaseId)

获取具有指定租用时间和建议租约 ID 的容器上的新租约。

Parameters:

leaseTimeInSeconds - 一个 ， Integer 指定获取租约的时间跨度（以秒为单位）。 如果为 null，则将获取无限租约。 如果不为 null，则该值必须大于零。

proposedLeaseId - 表示 String 新租约的建议租约 ID 的 ;如果未建议租约 ID，则为 null。

Returns:

表示 String 租约 ID 的 。

Throws:

StorageException - 如果发生存储服务错误。

acquireLease

public final String acquireLease(final Integer leaseTimeInSeconds, final String proposedLeaseId, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

获取具有指定租用时间、建议的租约 ID、请求选项和操作上下文的容器上的新租约。

Parameters:

leaseTimeInSeconds - 一个 ， Integer 指定获取租约的时间跨度（以秒为单位）。 如果为 null，则将获取无限租约。 如果不为 null，则该值必须大于零。

proposedLeaseId - 表示 String 新租约的建议租约 ID 的 ;如果未建议租约 ID，则为 null。

accessCondition - 一个表示容器访问条件的 AccessCondition 对象。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 (CloudBlobClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 上下文用于跟踪对存储服务的请求，并提供有关操作的其他运行时信息。

Returns:

表示 String 租约 ID 的 。

Throws:

StorageException - 如果发生存储服务错误。

breakLease

public final long breakLease(final Integer breakPeriodInSeconds)

中断租约，并确保其他客户端在当前租约期到期之前无法获取新租约。

Parameters:

breakPeriodInSeconds - 一个 ， Integer 指定在当前租约中断之前等待的时间（以秒为单位）。 如果为 null，则中断期是当前租约的剩余时间；对于无限期租约，则为零。

Returns:

租约期间剩余的时间（以秒为单位）。

Throws:

StorageException - 如果发生存储服务错误。

breakLease

public final long breakLease(final Integer breakPeriodInSeconds, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

使用指定的请求选项和操作上下文中断现有租约，并确保在当前租约期到期之前，其他客户端无法获取新的租约。

Parameters:

breakPeriodInSeconds - 一个 ， Integer 指定在当前租约中断之前等待的时间（以秒为单位）。 如果为 null，则中断期是当前租约的剩余时间；对于无限期租约，则为零。

accessCondition - 一个表示 Blob 访问条件的 AccessCondition 对象。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 (CloudBlobClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 上下文用于跟踪对存储服务的请求，并提供有关操作的其他运行时信息。

Returns:

租约期间剩余的时间（以秒为单位）。

Throws:

StorageException - 如果发生存储服务错误。

changeLease

public final String changeLease(final String proposedLeaseId, final AccessCondition accessCondition)

将现有租约 ID 更改为建议的租约 ID。

Parameters:

proposedLeaseId - 表示 String 新租约的建议租约 ID 的 ;如果未建议租约 ID，则为 null。

accessCondition - 一个表示 Blob 访问条件的 AccessCondition 对象。 需要使用访问条件设置租约 ID。

Returns:

表示 String 新租约 ID 的 。

Throws:

StorageException - 如果发生存储服务错误。

changeLease

public final String changeLease(final String proposedLeaseId, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

使用指定的访问条件、请求选项和操作上下文将现有租约 ID 更改为建议的租约 ID。

Parameters:

proposedLeaseId - 一个 String ，表示新租约的建议租约 ID。 此值不能为 null。

accessCondition - 一个表示 Blob 访问条件的 AccessCondition 对象。 需要使用访问条件设置租约 ID。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 (CloudBlobClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 上下文用于跟踪对存储服务的请求，并提供有关操作的其他运行时信息。

Returns:

表示 String 新租约 ID 的 。

Throws:

StorageException - 如果发生存储服务错误。

create

public void create()

创建容器。

Throws:

StorageException - 如果发生存储服务错误。

create

public void create(BlobContainerPublicAccessType accessType, BlobRequestOptions options, OperationContext opContext)

使用指定的选项和操作上下文创建容器。

Parameters:

accessType - 一个 BlobContainerPublicAccessType 对象，指定是否可以公开访问容器中的数据以及允许的访问级别。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudBlobClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Throws:

StorageException - 如果发生存储服务错误。

create

public void create(BlobRequestOptions options, OperationContext opContext)

使用指定的选项和操作上下文创建容器。

Parameters:

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudBlobClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Throws:

StorageException - 如果发生存储服务错误。

createIfNotExists

public boolean createIfNotExists()

如果容器不存在，则创建该容器。

Returns:

如果容器不存在但已创建，则为 true；否则为 false。

Throws:

StorageException - 如果发生存储服务错误。

createIfNotExists

public boolean createIfNotExists(BlobContainerPublicAccessType accessType, BlobRequestOptions options, OperationContext opContext)

使用指定的请求选项和操作上下文创建容器（如果不存在）。

Parameters:

accessType - 一个 BlobContainerPublicAccessType 对象，指定是否可以公开访问容器中的数据以及允许的访问级别。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 (CloudBlobClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

如果容器不存在但已创建，则为 true；否则为 false。

Throws:

StorageException - 如果发生存储服务错误。

createIfNotExists

public boolean createIfNotExists(BlobRequestOptions options, OperationContext opContext)

使用指定的请求选项和操作上下文创建容器（如果不存在）。

Parameters:

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 (CloudBlobClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

如果容器不存在但已创建，则为 true；否则为 false。

Throws:

StorageException - 如果发生存储服务错误。

delete

public void delete()

删除容器。

Throws:

StorageException - 如果发生存储服务错误。

delete

public void delete(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

使用指定的请求选项和操作上下文删除容器。

Parameters:

accessCondition - 一个表示容器访问条件的 AccessCondition 对象。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudBlobClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Throws:

StorageException - 如果发生存储服务错误。

deleteIfExists

public boolean deleteIfExists()

删除容器（如果存在）。

Returns:

如果容器不存在但已创建，则为 true；否则为 false。

Throws:

StorageException - 如果发生存储服务错误。

deleteIfExists

public boolean deleteIfExists(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

使用指定的请求选项和操作上下文删除容器（如果存在）。

Parameters:

accessCondition - 一个表示容器访问条件的 AccessCondition 对象。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudBlobClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

true 如果容器存在并且已删除，则为 ;否则为 false。

Throws:

StorageException - 如果发生存储服务错误。

downloadAccountInfo

public AccountInformation downloadAccountInfo()

获取与此容器所在的存储帐户相关的信息。

Returns:

AccountInformation给定存储帐户的 对象。

Throws:

StorageException - 如果发生存储服务错误。

downloadAccountInfo

public AccountInformation downloadAccountInfo(BlobRequestOptions options, OperationContext opContext)

获取与此容器所在的存储帐户相关的信息。

Parameters:

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudBlobClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

AccountInformation给定存储帐户的 对象。

Throws:

StorageException - 如果发生存储服务错误。

downloadAccountInformationImpl

protected StorageRequest downloadAccountInformationImpl(final RequestOptions options)

Parameters:

options

downloadAttributes

public void downloadAttributes()

下载容器的属性，这些属性由元数据和属性组成。

Throws:

StorageException - 如果发生存储服务错误。

downloadAttributes

public void downloadAttributes(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

使用指定的请求选项和操作上下文下载容器的属性，其中包括元数据和属性。

Parameters:

accessCondition - 一个表示容器访问条件的 AccessCondition 对象。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudBlobClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Throws:

StorageException - 如果发生存储服务错误。

downloadPermissions

public BlobContainerPermissions downloadPermissions()

下载容器的权限设置。

Returns:

一个 BlobContainerPermissions 表示容器权限的 对象。

Throws:

StorageException - 如果发生存储服务错误。

downloadPermissions

public BlobContainerPermissions downloadPermissions(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

使用指定的请求选项和操作上下文下载容器的权限设置。

Parameters:

accessCondition - 一个表示容器访问条件的 AccessCondition 对象。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudBlobClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

一个 BlobContainerPermissions 表示容器权限的 对象。

Throws:

StorageException - 如果发生存储服务错误。

exists

public boolean exists()

返回一个值，该值指示容器是否存在。

Returns:

true 如果容器存在，则为 ;否则为 false。

Throws:

StorageException - 如果发生存储服务错误。

exists

public boolean exists(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

使用指定的请求选项和操作上下文返回一个值，该值指示容器是否存在。

Parameters:

accessCondition - 一个表示容器访问条件的 AccessCondition 对象。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudBlobClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

true 如果容器存在，则为 ;否则为 false。

Throws:

StorageException - 如果发生存储服务错误。

generateSharedAccessSignature

public String generateSharedAccessSignature(final SharedAccessBlobPolicy policy, final String groupPolicyIdentifier)

返回容器的共享访问签名。 请注意，这不包含前导“？”。

Parameters:

policy - 一个 SharedAccessBlobPolicy 对象，表示共享访问签名的访问策略。

groupPolicyIdentifier - 表示 String 容器级访问策略的 。

Returns:

表示 String 容器的共享访问签名的 。

Throws:

StorageException - 如果发生存储服务错误。

InvalidKeyException - 如果密钥无效。

generateSharedAccessSignature

public String generateSharedAccessSignature(final SharedAccessBlobPolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)

返回容器的共享访问签名。 请注意，这不包含前导“？”。

Parameters:

policy - 一个 SharedAccessBlobPolicy 对象，表示共享访问签名的访问策略。

groupPolicyIdentifier - 表示 String 容器级访问策略的 。

ipRange - 包含 IPRange 允许的 IP 地址范围的 对象。

protocols - 表示 SharedAccessProtocols 允许的 Internet 协议的 。

Returns:

表示 String 容器的共享访问签名的 。

Throws:

StorageException - 如果发生存储服务错误。

InvalidKeyException - 如果密钥无效。

getAppendBlobReference

public CloudAppendBlob getAppendBlobReference(final String blobName)

返回对 CloudAppendBlob 对象的引用，该对象表示此容器中的追加 Blob。

Parameters:

blobName - 一个 String ，它表示 Blob 的名称。

Returns:

一个 CloudAppendBlob 对象，表示对指定追加 Blob 的引用。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException - 如果资源 URI 无效。

getAppendBlobReference

public CloudAppendBlob getAppendBlobReference(final String blobName, final String snapshotID)

使用指定的快照 ID，返回对 CloudAppendBlob 表示容器中追加 blob 的 对象的引用。

Parameters:

blobName - 一个 String ，它表示 Blob 的名称。

snapshotID - 一个 String ，表示 blob 的快照 ID。

Returns:

一个 CloudAppendBlob 对象，表示对指定追加 Blob 的引用。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException - 如果资源 URI 无效。

getBlobReferenceFromServer

public final CloudBlob getBlobReferenceFromServer(final String blobName)

获取对此容器中的 Blob 的引用。 Blob 必须已存在于服务中。

与其他 get*Reference 方法不同，此方法执行服务请求来检索 Blob 的元数据和属性。 返回的 Blob 可以直接用作 CloudBlob，也可以使用 instanceof 或 getProperties () .getBlobType () 进行强制转换，以确定其子类型。

Parameters:

blobName - 一个 String ，它表示 Blob 的名称。

Returns:

一个 CloudBlob 对象，该对象表示对指定 Blob 的引用。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException - 如果资源 URI 无效。

getBlobReferenceFromServer

public final CloudBlob getBlobReferenceFromServer(final String blobName, final String snapshotID, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

获取对此容器中的 Blob 的引用。 Blob 必须已存在于服务中。

与其他 get*Reference 方法不同，此方法执行服务请求来检索 Blob 的元数据和属性。 返回的 Blob 可以直接用作 CloudBlob，也可以使用 instanceof 或 getProperties () .getBlobType () 进行强制转换，以确定其子类型。

Parameters:

blobName - 一个 String ，它表示 Blob 的名称。

snapshotID - 一个 String ，表示 blob 的快照 ID。

accessCondition - 一个表示 Blob 访问条件的 AccessCondition 对象。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudBlobClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

一个 CloudBlob 对象，该对象表示对指定 Blob 的引用。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException - 如果资源 URI 无效。

getBlockBlobReference

public CloudBlockBlob getBlockBlobReference(final String blobName)

返回对 CloudBlockBlob 表示此容器中的块 Blob 的 对象的引用。

Parameters:

blobName - 一个 String ，表示 Blob 的名称。

Returns:

一个 CloudBlockBlob 对象，表示对指定块 Blob 的引用。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException - 如果资源 URI 无效。

getBlockBlobReference

public CloudBlockBlob getBlockBlobReference(final String blobName, final String snapshotID)

使用指定的快照 ID 返回对CloudBlockBlob表示此容器中的块 Blob 的 对象的引用。

Parameters:

blobName - 一个 String ，表示 Blob 的名称。

snapshotID - 一个 String ，表示 blob 的快照 ID。

Returns:

一个 CloudBlockBlob 对象，表示对指定块 Blob 的引用。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException - 如果资源 URI 无效。

getDirectoryReference

public CloudBlobDirectory getDirectoryReference(String directoryName)

返回对 CloudBlobDirectory 对象的引用，该对象表示此容器中的虚拟 Blob 目录。

Parameters:

directoryName - 一个 String ，表示虚拟 Blob 目录的名称。 如果需要根目录 (表示容器本身) 的目录，请使用空字符串。

Returns:

一个 CloudBlobDirectory ，它表示此容器中的虚拟 Blob 目录。

Throws:

URISyntaxException - 如果资源 URI 无效。

getMetadata

public HashMap getMetadata()

返回容器的元数据。 此值通过调用 downloadAttributes()，使用队列中的元数据进行初始化，并且通过调用 uploadMetadata()在队列上设置此值。

Returns:

一个 java.util.HashMap 对象，表示容器的元数据。

getName

public String getName()

返回容器的名称。

Returns:

一个 String ，它表示容器的名称。

getPageBlobReference

public CloudPageBlob getPageBlobReference(final String blobName)

返回对 CloudPageBlob 表示此容器中的页 Blob 的 对象的引用。

Parameters:

blobName - 一个 String ，表示 Blob 的名称。

Returns:

一个 CloudPageBlob 对象，表示对指定页 Blob 的引用。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException - 如果资源 URI 无效。

getPageBlobReference

public CloudPageBlob getPageBlobReference(final String blobName, final String snapshotID)

使用指定的快照 ID 返回对 CloudPageBlob 表示容器中页 Blob 的 对象的引用。

Parameters:

blobName - 一个 String ，表示 Blob 的名称。

snapshotID - 一个 String ，表示 blob 的快照 ID。

Returns:

一个 CloudPageBlob 对象，表示对指定页 Blob 的引用。

Throws:

StorageException - 如果发生存储服务错误。

URISyntaxException - 如果资源 URI 无效。

getProperties

public BlobContainerProperties getProperties()

返回容器的属性。

Returns:

一个 BlobContainerProperties 对象，表示容器的属性。

getServiceClient

public CloudBlobClient getServiceClient()

返回与此容器关联的 Blob 服务客户端。

Returns:

一个 CloudBlobClient 对象，表示与此容器关联的服务客户端。

getStorageUri

public StorageUri getStorageUri()

返回所有位置的 URI 列表。

Returns:

一个 StorageUri 对象，它表示所有位置的 URI 列表。

getUri

public URI getUri()

返回此容器的 URI。

Returns:

容器的绝对 URI。

listBlobs

public Iterable listBlobs()

返回容器的 Blob 项的可枚举集合。

Returns:

延迟检索的 ListBlobItem 对象的可枚举集合，表示此容器中的项。

listBlobs

public Iterable listBlobs(final String prefix)

返回容器的 Blob 项的可枚举集合，其名称以指定前缀开头。

Parameters:

prefix - 一个 String ，它表示 Blob 名称前缀。 此值的前面必须是容器的名称或容器的绝对路径。

Returns:

延迟检索的 ListBlobItem 对象的可枚举集合，该集合表示名称以此容器中的指定前缀开头的项。

listBlobs

public Iterable listBlobs(final String prefix, final boolean useFlatBlobListing)

返回容器的 Blob 项的可枚举集合，该容器的名称使用指定的平面或分层选项以指定前缀开头。

Parameters:

prefix - 一个 String ，它表示 Blob 名称前缀。 此值的前面必须是容器的名称或容器的绝对路径。

useFlatBlobListing -

true 以指示返回的列表将为平面; false 以指示返回的列表将是分层的。

Returns:

延迟检索的 ListBlobItem 对象的可枚举集合，该集合表示名称以此容器中的指定前缀开头的项。

listBlobs

public Iterable listBlobs(final String prefix, final boolean useFlatBlobListing, final EnumSet listingDetails, BlobRequestOptions options, OperationContext opContext)

返回容器的 Blob 项的可枚举集合，该容器的名称以指定前缀开头，使用指定的平面或分层选项、列出详细信息选项、请求选项和操作上下文。

Parameters:

prefix - 一个 String ，它表示 Blob 名称前缀。 此值的前面必须是容器的名称或容器的绝对路径。

useFlatBlobListing -

true 以指示返回的列表将为平面; false 以指示返回的列表将是分层的。

listingDetails - 一个 java.util.EnumSet 对象，其中包含 BlobListingDetails 指示是否返回快照、软删除的 Blob、元数据和/或未提交的块的值。 始终返回提交的块。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudBlobClient 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

延迟检索的 ListBlobItem 对象的可枚举集合，该集合表示名称以此容器中的指定前缀开头的项。

listBlobsSegmented

public ResultSegment listBlobsSegmented()

返回容器中 Blob 项的可枚举集合的结果段。

Returns:

一个 ResultSegment<T> 对象，该对象包含表示容器中的 Blob 项的 ListBlobItem 可枚举对象集合的段。

Throws:

StorageException - 如果发生存储服务错误。

listBlobsSegmented

public ResultSegment listBlobsSegmented(final String prefix)

返回一个结果段，其中包含其名称以指定前缀开头的 blob 项集合。

Parameters:

prefix - 一个 String ，它表示 Blob 名称的前缀。

Returns:

一个 ResultSegment<T> 对象，该对象包含对象可枚举集合的 ListBlobItem 段，这些对象表示其名称以容器中指定前缀开头的 Blob 项。

Throws:

StorageException - 如果发生存储服务错误。

listBlobsSegmented

public ResultSegment listBlobsSegmented(final String prefix, final boolean useFlatBlobListing, final EnumSet listingDetails, final Integer maxResults, final ResultContinuation continuationToken, BlobRequestOptions options, OperationContext opContext)

返回一个结果段，其中包含名称以指定前缀开头、使用指定的平面或分层选项、列出详细信息选项、请求选项和操作上下文的 blob 项集合。

Parameters:

prefix - 一个 String ，它表示 Blob 名称的前缀。

useFlatBlobListing -

true 以指示返回的列表将为平面; false 以指示返回的列表将是分层的。

listingDetails - 一个 java.util.EnumSet 对象，其中包含 BlobListingDetails 指示是否返回快照、软删除的 Blob、元数据和/或未提交的块的值。 始终返回提交的块。

maxResults - 要检索的最大结果数。 如果 null 或大于 5000，服务器将返回最多 5,000 个项。 必须至少为 1。

continuationToken - 一个 ResultContinuation 对象，该对象表示上一个列表操作返回的继续标记。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudBlobClient 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

一个 ResultSegment<T> 对象，该对象包含可枚举对象集合的 ListBlobItem 段，这些对象表示其名称以容器中指定前缀开头的块项。

Throws:

StorageException - 如果发生存储服务错误。

listContainers

public Iterable listContainers()

返回与此容器关联的服务客户端的容器的可枚举集合。

Returns:

延迟检索的 CloudBlobContainer 对象的可枚举集合，这些对象表示与此容器关联的服务客户端的容器。

listContainers

public Iterable listContainers(final String prefix)

返回容器的可枚举集合，其名称以与此容器关联的服务客户端的指定前缀开头。

Parameters:

prefix - 一个 String ，它表示容器名称前缀。

Returns:

延迟检索的 CloudBlobContainer 对象的可枚举集合，该集合表示名称以与此容器关联的服务客户端的指定前缀开头的容器。

listContainers

public Iterable listContainers(final String prefix, final ContainerListingDetails detailsIncluded, final BlobRequestOptions options, final OperationContext opContext)

使用指定的详细信息设置、请求选项和操作上下文返回容器的可枚举集合，其名称以与此容器关联的服务客户端的指定前缀开头。

Parameters:

prefix - 一个 String ，它表示容器名称前缀。

detailsIncluded - 一个 ContainerListingDetails 值，该值指示是否将返回容器元数据。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 () CloudBlobClient 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

延迟检索的 CloudBlobContainer 对象的可枚举集合，表示与此容器关联的服务客户端的容器。

listContainersSegmented

public ResultSegment listContainersSegmented()

返回与此容器关联的服务客户端的可枚举容器集合的结果段。

Returns:

一个 ResultSegment<T> 对象，该对象包含对象可枚举集合的 CloudBlobContainer 段，这些对象表示与此容器关联的服务客户端的容器。

Throws:

StorageException - 如果发生存储服务错误。

listContainersSegmented

public ResultSegment listContainersSegmented(final String prefix)

返回容器的可枚举集合的结果段，其名称以与此容器关联的服务客户端的指定前缀开头。

Parameters:

prefix - 一个 String ，它表示 Blob 名称前缀。

Returns:

一个 ResultSegment<T> 对象，该对象包含对象的可枚举集合 CloudBlobContainer 的段，这些对象表示名称以与此容器关联的服务客户端的指定前缀开头的容器。

Throws:

StorageException - 如果发生存储服务错误。

listContainersSegmented

public ResultSegment listContainersSegmented(final String prefix, final ContainerListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final BlobRequestOptions options, final OperationContext opContext)

使用指定的列表详细信息选项、请求选项和操作上下文返回包含容器集合的结果段，这些容器的名称以与此容器关联的服务客户端的指定前缀开头。

Parameters:

prefix - 一个 String ，它表示容器名称的前缀。

detailsIncluded - 一个 ContainerListingDetails 对象，该对象指示是否包含元数据。

maxResults - 要检索的最大结果数。 如果 null 或大于 5000，服务器将返回最多 5,000 个项目。 必须至少为 1。

continuationToken - 一个 ResultContinuation 对象，表示上一个列表操作返回的继续标记。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudBlobClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Returns:

一个 ResultSegment<T> 对象，该对象包含对象的可枚举集合 CloudBlobContainer 的段，这些对象表示名称以与此容器关联的服务客户端的指定前缀开头的容器。

Throws:

StorageException - 如果发生存储服务错误。

releaseLease

public final void releaseLease(final AccessCondition accessCondition)

释放容器上的租约。

Parameters:

accessCondition - 一个表示 Blob 访问条件的 AccessCondition 对象。 需要使用访问条件设置租约 ID。

Throws:

StorageException - 如果发生存储服务错误。

releaseLease

public final void releaseLease(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

使用指定的访问条件、请求选项和操作上下文释放容器上的租约。

Parameters:

accessCondition - 一个表示 Blob 访问条件的 AccessCondition 对象。 需要使用访问条件设置租约 ID。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 (CloudBlobClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 上下文用于跟踪对存储服务的请求，并提供有关操作的其他运行时信息。

Throws:

StorageException - 如果发生存储服务错误。

renewLease

public final void renewLease(final AccessCondition accessCondition)

使用指定的访问条件续订现有租约。

Parameters:

accessCondition - 一个表示容器访问条件的 AccessCondition 对象。 需要使用访问条件设置租约 ID。

Throws:

StorageException - 如果发生存储服务错误。

renewLease

public final void renewLease(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

使用指定的访问条件、请求选项和操作上下文续订现有租约。

Parameters:

accessCondition - 一个表示 Blob 访问条件的 AccessCondition 对象。 需要使用访问条件设置租约 ID。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 (CloudBlobClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 上下文用于跟踪对存储服务的请求，并提供有关操作的其他运行时信息。

Throws:

StorageException - 如果发生存储服务错误。

setMetadata

public void setMetadata(final HashMap metadata)

通过调用设置要在容器 uploadMetadata() 上设置的名称/值对的元数据集合。 此集合将覆盖任何现有容器元数据。 如果将其设置为空集合，则会在调用时 uploadMetadata() 清除容器元数据。

Parameters:

metadata - 一个 java.util.HashMap 对象，表示要分配给容器的元数据。

setProperties

protected void setProperties(final BlobContainerProperties properties)

设置容器的属性。

Parameters:

properties - 一个 BlobContainerProperties 对象，表示要分配给容器的属性。

setStorageUri

protected void setStorageUri(final StorageUri storageUri)

设置所有位置的 URI 列表。

Parameters:

storageUri - 一个 StorageUri 对象，该对象表示所有位置的 URI 列表。

uploadMetadata

public void uploadMetadata()

上传容器的元数据。

Throws:

StorageException - 如果发生存储服务错误。

uploadMetadata

public void uploadMetadata(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

使用指定的请求选项和操作上下文上传容器的元数据。

Parameters:

accessCondition - 一个表示容器访问条件的 AccessCondition 对象。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudBlobClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Throws:

StorageException - 如果发生存储服务错误。

uploadPermissions

public void uploadPermissions(final BlobContainerPermissions permissions)

上传容器的权限。

Parameters:

permissions - 一个 BlobContainerPermissions 表示上传权限的 对象。

Throws:

StorageException - 如果发生存储服务错误。

uploadPermissions

public void uploadPermissions(final BlobContainerPermissions permissions, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)

使用指定的请求选项和操作上下文上传容器的权限。

Parameters:

permissions - 一个 BlobContainerPermissions 表示上传权限的 对象。

accessCondition - 一个表示容器访问条件的 AccessCondition 对象。

options - 一个 BlobRequestOptions 对象，该对象指定请求的任何其他选项。 指定 null 将使用关联服务客户端 ( CloudBlobClient) 的默认请求选项。

opContext - 一个 OperationContext 对象，它一个表示当前操作的上下文。 此对象用于跟踪对存储服务的请求并提供有关操作的其他运行时信息。

Throws:

StorageException - 如果发生存储服务错误。