azure-docs-sdk-java/docs-ref-autogen/com.microsoft.azure.storage...

3295 строки
191 KiB
YAML

### YamlMime:ManagedReference
items:
- uid: com.microsoft.azure.storage.blob._cloud_blob_container
id: _cloud_blob_container
parent: com.microsoft.azure.storage.blob
children:
- com.microsoft.azure.storage.blob._cloud_blob_container.acquireLease()
- com.microsoft.azure.storage.blob._cloud_blob_container.acquireLease(final Integer,final String)
- com.microsoft.azure.storage.blob._cloud_blob_container.acquireLease(final Integer,final String,final AccessCondition,BlobRequestOptions,OperationContext)
- com.microsoft.azure.storage.blob._cloud_blob_container.breakLease(final Integer)
- com.microsoft.azure.storage.blob._cloud_blob_container.breakLease(final Integer,final AccessCondition,BlobRequestOptions,OperationContext)
- com.microsoft.azure.storage.blob._cloud_blob_container.changeLease(final String,final AccessCondition)
- com.microsoft.azure.storage.blob._cloud_blob_container.changeLease(final String,final AccessCondition,BlobRequestOptions,OperationContext)
- com.microsoft.azure.storage.blob._cloud_blob_container.CloudBlobContainer(final StorageUri)
- com.microsoft.azure.storage.blob._cloud_blob_container.CloudBlobContainer(final StorageUri,final StorageCredentials)
- com.microsoft.azure.storage.blob._cloud_blob_container.CloudBlobContainer(final String,final CloudBlobClient)
- com.microsoft.azure.storage.blob._cloud_blob_container.CloudBlobContainer(final URI)
- com.microsoft.azure.storage.blob._cloud_blob_container.CloudBlobContainer(final URI,final StorageCredentials)
- com.microsoft.azure.storage.blob._cloud_blob_container.create()
- com.microsoft.azure.storage.blob._cloud_blob_container.create(BlobContainerPublicAccessType,BlobRequestOptions,OperationContext)
- com.microsoft.azure.storage.blob._cloud_blob_container.create(BlobRequestOptions,OperationContext)
- com.microsoft.azure.storage.blob._cloud_blob_container.createIfNotExists()
- com.microsoft.azure.storage.blob._cloud_blob_container.createIfNotExists(BlobContainerPublicAccessType,BlobRequestOptions,OperationContext)
- com.microsoft.azure.storage.blob._cloud_blob_container.createIfNotExists(BlobRequestOptions,OperationContext)
- com.microsoft.azure.storage.blob._cloud_blob_container.delete()
- com.microsoft.azure.storage.blob._cloud_blob_container.delete(AccessCondition,BlobRequestOptions,OperationContext)
- com.microsoft.azure.storage.blob._cloud_blob_container.deleteIfExists()
- com.microsoft.azure.storage.blob._cloud_blob_container.deleteIfExists(AccessCondition,BlobRequestOptions,OperationContext)
- com.microsoft.azure.storage.blob._cloud_blob_container.downloadAccountInfo()
- com.microsoft.azure.storage.blob._cloud_blob_container.downloadAccountInfo(BlobRequestOptions,OperationContext)
- com.microsoft.azure.storage.blob._cloud_blob_container.downloadAccountInformationImpl(final RequestOptions)
- com.microsoft.azure.storage.blob._cloud_blob_container.downloadAttributes()
- com.microsoft.azure.storage.blob._cloud_blob_container.downloadAttributes(AccessCondition,BlobRequestOptions,OperationContext)
- com.microsoft.azure.storage.blob._cloud_blob_container.downloadPermissions()
- com.microsoft.azure.storage.blob._cloud_blob_container.downloadPermissions(AccessCondition,BlobRequestOptions,OperationContext)
- com.microsoft.azure.storage.blob._cloud_blob_container.exists()
- com.microsoft.azure.storage.blob._cloud_blob_container.exists(final AccessCondition,BlobRequestOptions,OperationContext)
- com.microsoft.azure.storage.blob._cloud_blob_container.generateSharedAccessSignature(final SharedAccessBlobPolicy,final String)
- com.microsoft.azure.storage.blob._cloud_blob_container.generateSharedAccessSignature(final SharedAccessBlobPolicy,final String,final IPRange,final SharedAccessProtocols)
- com.microsoft.azure.storage.blob._cloud_blob_container.getAppendBlobReference(final String)
- com.microsoft.azure.storage.blob._cloud_blob_container.getAppendBlobReference(final String,final String)
- com.microsoft.azure.storage.blob._cloud_blob_container.getBlobReferenceFromServer(final String)
- com.microsoft.azure.storage.blob._cloud_blob_container.getBlobReferenceFromServer(final String,final String,AccessCondition,BlobRequestOptions,OperationContext)
- com.microsoft.azure.storage.blob._cloud_blob_container.getBlockBlobReference(final String)
- com.microsoft.azure.storage.blob._cloud_blob_container.getBlockBlobReference(final String,final String)
- com.microsoft.azure.storage.blob._cloud_blob_container.getDirectoryReference(String)
- com.microsoft.azure.storage.blob._cloud_blob_container.getMetadata()
- com.microsoft.azure.storage.blob._cloud_blob_container.getName()
- com.microsoft.azure.storage.blob._cloud_blob_container.getPageBlobReference(final String)
- com.microsoft.azure.storage.blob._cloud_blob_container.getPageBlobReference(final String,final String)
- com.microsoft.azure.storage.blob._cloud_blob_container.getProperties()
- com.microsoft.azure.storage.blob._cloud_blob_container.getServiceClient()
- com.microsoft.azure.storage.blob._cloud_blob_container.getStorageUri()
- com.microsoft.azure.storage.blob._cloud_blob_container.getUri()
- com.microsoft.azure.storage.blob._cloud_blob_container.listBlobs()
- com.microsoft.azure.storage.blob._cloud_blob_container.listBlobs(final String)
- com.microsoft.azure.storage.blob._cloud_blob_container.listBlobs(final String,final boolean)
- com.microsoft.azure.storage.blob._cloud_blob_container.listBlobs(final String,final boolean,final EnumSet<BlobListingDetails>,BlobRequestOptions,OperationContext)
- com.microsoft.azure.storage.blob._cloud_blob_container.listBlobsSegmented()
- com.microsoft.azure.storage.blob._cloud_blob_container.listBlobsSegmented(final String)
- com.microsoft.azure.storage.blob._cloud_blob_container.listBlobsSegmented(final String,final boolean,final EnumSet<BlobListingDetails>,final Integer,final ResultContinuation,BlobRequestOptions,OperationContext)
- com.microsoft.azure.storage.blob._cloud_blob_container.listContainers()
- com.microsoft.azure.storage.blob._cloud_blob_container.listContainers(final String)
- com.microsoft.azure.storage.blob._cloud_blob_container.listContainers(final String,final ContainerListingDetails,final BlobRequestOptions,final OperationContext)
- com.microsoft.azure.storage.blob._cloud_blob_container.listContainersSegmented()
- com.microsoft.azure.storage.blob._cloud_blob_container.listContainersSegmented(final String)
- com.microsoft.azure.storage.blob._cloud_blob_container.listContainersSegmented(final String,final ContainerListingDetails,final Integer,final ResultContinuation,final BlobRequestOptions,final OperationContext)
- com.microsoft.azure.storage.blob._cloud_blob_container.metadata
- com.microsoft.azure.storage.blob._cloud_blob_container.releaseLease(final AccessCondition)
- com.microsoft.azure.storage.blob._cloud_blob_container.releaseLease(final AccessCondition,BlobRequestOptions,OperationContext)
- com.microsoft.azure.storage.blob._cloud_blob_container.renewLease(final AccessCondition)
- com.microsoft.azure.storage.blob._cloud_blob_container.renewLease(final AccessCondition,BlobRequestOptions,OperationContext)
- com.microsoft.azure.storage.blob._cloud_blob_container.setMetadata(final HashMap<String, String>)
- com.microsoft.azure.storage.blob._cloud_blob_container.setProperties(final BlobContainerProperties)
- com.microsoft.azure.storage.blob._cloud_blob_container.setStorageUri(final StorageUri)
- com.microsoft.azure.storage.blob._cloud_blob_container.uploadMetadata()
- com.microsoft.azure.storage.blob._cloud_blob_container.uploadMetadata(AccessCondition,BlobRequestOptions,OperationContext)
- com.microsoft.azure.storage.blob._cloud_blob_container.uploadPermissions(final BlobContainerPermissions)
- com.microsoft.azure.storage.blob._cloud_blob_container.uploadPermissions(final BlobContainerPermissions,final AccessCondition,BlobRequestOptions,OperationContext)
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: CloudBlobContainer
nameWithType: CloudBlobContainer
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer
type: Class
source:
remote: &o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
branch: master
repo: https://github.com/Azure/azure-storage-java
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 39
package: com.microsoft.azure.storage.blob
summary: >-
<p>Represents a container in the Microsoft Azure Blob service. </p>
<p>Containers hold directories, which are encapsulated as <xref uid="com.microsoft.azure.storage.blob._cloud_blob_directory" data-throw-if-not-resolved="false">CloudBlobDirectory</xref> objects, and directories hold block blobs and page blobs. Directories can also contain sub-directories. </p>
syntax: &o3
content: public class CloudBlobContainer
inheritance:
- java.lang.Object
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.acquireLease()
id: acquireLease()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: acquireLease()
nameWithType: CloudBlobContainer.acquireLease()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.acquireLease()
overload: com.microsoft.azure.storage.blob._cloud_blob_container.acquireLease*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1887
package: com.microsoft.azure.storage.blob
summary: >-
<p>Acquires a new infinite lease on the container.</p>
<p></p>
syntax:
content: public final String acquireLease()
return:
type: 3d93591e
description: <p>A <code>String</code> that represents the lease ID.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.acquireLease(final Integer,final String)
id: acquireLease(final Integer,final String)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: acquireLease(final Integer leaseTimeInSeconds, final String proposedLeaseId)
nameWithType: CloudBlobContainer.acquireLease(final Integer leaseTimeInSeconds, final String proposedLeaseId)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.acquireLease(final Integer leaseTimeInSeconds, final String proposedLeaseId)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.acquireLease*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1909
package: com.microsoft.azure.storage.blob
summary: >-
<p>Acquires a new lease on the container with the specified lease time and proposed lease ID.</p>
<p></p>
syntax:
content: public final String acquireLease(final Integer leaseTimeInSeconds, final String proposedLeaseId)
parameters:
- id: leaseTimeInSeconds
type: 3437983f
description: <p>An <code>Integer</code> which specifies the span of time for which to acquire the lease, in seconds. If null, an infinite lease will be acquired. If not null, the value must be greater than zero.</p>
- id: proposedLeaseId
type: 3d93591e
description: <p>A <code>String</code> that represents the proposed lease ID for the new lease, or null if no lease ID is proposed.</p>
return:
type: 3d93591e
description: <p>A <code>String</code> that represents the lease ID.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.acquireLease(final Integer,final String,final AccessCondition,BlobRequestOptions,OperationContext)
id: acquireLease(final Integer,final String,final AccessCondition,BlobRequestOptions,OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: acquireLease(final Integer leaseTimeInSeconds, final String proposedLeaseId, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
nameWithType: CloudBlobContainer.acquireLease(final Integer leaseTimeInSeconds, final String proposedLeaseId, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.acquireLease(final Integer leaseTimeInSeconds, final String proposedLeaseId, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.acquireLease*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1947
package: com.microsoft.azure.storage.blob
summary: >-
<p>Acquires a new lease on the container with the specified lease time, proposed lease ID, request options, and operation context.</p>
<p></p>
syntax:
content: public final String acquireLease(final Integer leaseTimeInSeconds, final String proposedLeaseId, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
parameters:
- id: leaseTimeInSeconds
type: 3437983f
description: <p>An <code>Integer</code> which specifies the span of time for which to acquire the lease, in seconds. If null, an infinite lease will be acquired. If not null, the value must be greater than zero.</p>
- id: proposedLeaseId
type: 3d93591e
description: <p>A <code>String</code> that represents the proposed lease ID for the new lease, or null if no lease ID is proposed.</p>
- id: accessCondition
type: 93de0ef9com.microsoft.azure.storage._access_condition
description: <p>An <xref uid="com.microsoft.azure.storage._access_condition" data-throw-if-not-resolved="false">AccessCondition</xref> object that represents the access conditions for the container.</p>
- id: options
type: com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client (<xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>).</p>
- id: opContext
type: com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. The context is used to track requests to the storage service, and to provide additional runtime information about the operation.</p>
return:
type: 3d93591e
description: <p>A <code>String</code> that represents the lease ID.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.breakLease(final Integer)
id: breakLease(final Integer)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: breakLease(final Integer breakPeriodInSeconds)
nameWithType: CloudBlobContainer.breakLease(final Integer breakPeriodInSeconds)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.breakLease(final Integer breakPeriodInSeconds)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.breakLease*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 2189
package: com.microsoft.azure.storage.blob
summary: >-
<p>Breaks the lease and ensures that another client cannot acquire a new lease until the current lease period has expired.</p>
<p></p>
syntax:
content: public final long breakLease(final Integer breakPeriodInSeconds)
parameters:
- id: breakPeriodInSeconds
type: 3437983f
description: <p>An <code>Integer</code> which specifies the time to wait, in seconds, until the current lease is broken. If null, the break period is the remainder of the current lease, or zero for infinite leases.</p>
return:
type: 4c60ae65
description: <p>The time, in seconds, remaining in the lease period.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.breakLease(final Integer,final AccessCondition,BlobRequestOptions,OperationContext)
id: breakLease(final Integer,final AccessCondition,BlobRequestOptions,OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: breakLease(final Integer breakPeriodInSeconds, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
nameWithType: CloudBlobContainer.breakLease(final Integer breakPeriodInSeconds, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.breakLease(final Integer breakPeriodInSeconds, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.breakLease*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 2219
package: com.microsoft.azure.storage.blob
summary: >-
<p>Breaks the existing lease, using the specified request options and operation context, and ensures that another client cannot acquire a new lease until the current lease period has expired.</p>
<p></p>
syntax:
content: public final long breakLease(final Integer breakPeriodInSeconds, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
parameters:
- id: breakPeriodInSeconds
type: 3437983f
description: <p>An <code>Integer</code> which specifies the time to wait, in seconds, until the current lease is broken. If null, the break period is the remainder of the current lease, or zero for infinite leases.</p>
- id: accessCondition
type: 93de0ef9com.microsoft.azure.storage._access_condition
description: <p>An <xref uid="com.microsoft.azure.storage._access_condition" data-throw-if-not-resolved="false">AccessCondition</xref> object that represents the access conditions for the blob. </p>
- id: options
type: com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client (<xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>). </p>
- id: opContext
type: com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. The context is used to track requests to the storage service, and to provide additional runtime information about the operation.</p>
return:
type: 4c60ae65
description: <p>The time, in seconds, remaining in the lease period.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.changeLease(final String,final AccessCondition)
id: changeLease(final String,final AccessCondition)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: changeLease(final String proposedLeaseId, final AccessCondition accessCondition)
nameWithType: CloudBlobContainer.changeLease(final String proposedLeaseId, final AccessCondition accessCondition)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.changeLease(final String proposedLeaseId, final AccessCondition accessCondition)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.changeLease*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 2288
package: com.microsoft.azure.storage.blob
summary: >-
<p>Changes the existing lease ID to the proposed lease ID.</p>
<p></p>
syntax:
content: public final String changeLease(final String proposedLeaseId, final AccessCondition accessCondition)
parameters:
- id: proposedLeaseId
type: 3d93591e
description: <p>A <code>String</code> that represents the proposed lease ID for the new lease, or null if no lease ID is proposed.</p>
- id: accessCondition
type: 93de0ef9com.microsoft.azure.storage._access_condition
description: <p>An <xref uid="com.microsoft.azure.storage._access_condition" data-throw-if-not-resolved="false">AccessCondition</xref> object that represents the access conditions for the blob. The lease ID is required to be set with an access condition. </p>
return:
type: 3d93591e
description: <p>A <code>String</code> that represents the new lease ID.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.changeLease(final String,final AccessCondition,BlobRequestOptions,OperationContext)
id: changeLease(final String,final AccessCondition,BlobRequestOptions,OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: changeLease(final String proposedLeaseId, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
nameWithType: CloudBlobContainer.changeLease(final String proposedLeaseId, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.changeLease(final String proposedLeaseId, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.changeLease*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 2319
package: com.microsoft.azure.storage.blob
summary: >-
<p>Changes the existing lease ID to the proposed lease Id with the specified access conditions, request options, and operation context.</p>
<p></p>
syntax:
content: public final String changeLease(final String proposedLeaseId, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
parameters:
- id: proposedLeaseId
type: 3d93591e
description: <p>A <code>String</code> that represents the proposed lease ID for the new lease. This cannot be null.</p>
- id: accessCondition
type: 93de0ef9com.microsoft.azure.storage._access_condition
description: <p>An <xref uid="com.microsoft.azure.storage._access_condition" data-throw-if-not-resolved="false">AccessCondition</xref> object that represents the access conditions for the blob. The lease ID is required to be set with an access condition.</p>
- id: options
type: com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client (<xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>).</p>
- id: opContext
type: com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. The context is used to track requests to the storage service, and to provide additional runtime information about the operation. </p>
return:
type: 3d93591e
description: <p>A <code>String</code> that represents the new lease ID.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.CloudBlobContainer(final StorageUri)
id: CloudBlobContainer(final StorageUri)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: CloudBlobContainer(final StorageUri storageUri)
nameWithType: CloudBlobContainer.CloudBlobContainer(final StorageUri storageUri)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.CloudBlobContainer(final StorageUri storageUri)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.CloudBlobContainer*
type: Constructor
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 107
package: com.microsoft.azure.storage.blob
summary: >-
<p>Creates an instance of the class using the specified URI. The blob URI should include a SAS token unless anonymous access is to be used.</p>
<p></p>
syntax:
content: public CloudBlobContainer(final StorageUri storageUri)
parameters:
- id: storageUri
type: 93de0ef9com.microsoft.azure.storage._storage_uri
description: <p>A <xref uid="com.microsoft.azure.storage._storage_uri" data-throw-if-not-resolved="false">StorageUri</xref> object which represents the URI of the container.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.CloudBlobContainer(final StorageUri,final StorageCredentials)
id: CloudBlobContainer(final StorageUri,final StorageCredentials)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: CloudBlobContainer(final StorageUri storageUri, final StorageCredentials credentials)
nameWithType: CloudBlobContainer.CloudBlobContainer(final StorageUri storageUri, final StorageCredentials credentials)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.CloudBlobContainer(final StorageUri storageUri, final StorageCredentials credentials)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.CloudBlobContainer*
type: Constructor
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 137
package: com.microsoft.azure.storage.blob
summary: >-
<p>Creates an instance of the class using the specified StorageUri and credentials.</p>
<p></p>
syntax:
content: public CloudBlobContainer(final StorageUri storageUri, final StorageCredentials credentials)
parameters:
- id: storageUri
type: 93de0ef9com.microsoft.azure.storage._storage_uri
description: <p>A <xref uid="com.microsoft.azure.storage._storage_uri" data-throw-if-not-resolved="false">StorageUri</xref> object which represents the absolute StorageUri of the container. </p>
- id: credentials
type: 93de0ef9com.microsoft.azure.storage._storage_credentials
description: <p>A <xref uid="com.microsoft.azure.storage._storage_credentials" data-throw-if-not-resolved="false">StorageCredentials</xref> object used to authenticate access.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.CloudBlobContainer(final String,final CloudBlobClient)
id: CloudBlobContainer(final String,final CloudBlobClient)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: CloudBlobContainer(final String containerName, final CloudBlobClient client)
nameWithType: CloudBlobContainer.CloudBlobContainer(final String containerName, final CloudBlobClient client)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.CloudBlobContainer(final String containerName, final CloudBlobClient client)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.CloudBlobContainer*
type: Constructor
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 163
package: com.microsoft.azure.storage.blob
summary: >-
<p>Creates an instance of the class using the specified name and client.</p>
<p></p>
syntax:
content: protected CloudBlobContainer(final String containerName, final CloudBlobClient client)
parameters:
- id: containerName
type: 3d93591e
description: <p>A <code>String</code> which represents the name of the container, which must adhere to container naming rules. The container name should not include any path separator characters (/). Container names must be lowercase, between 3-63 characters long and must start with a letter or number. Container names may contain only letters, numbers, and the dash (-) character. </p>
- id: client
type: 93de0ef9com.microsoft.azure.storage.blob._cloud_blob_client
description: <p>A <xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref> object that represents the associated service client, and that specifies the endpoint for the Blob service. *</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- type: "44102508"
description: <p>If the resource URI constructed based on the containerName is invalid.</p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.CloudBlobContainer(final URI)
id: CloudBlobContainer(final URI)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: CloudBlobContainer(final URI uri)
nameWithType: CloudBlobContainer.CloudBlobContainer(final URI uri)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.CloudBlobContainer(final URI uri)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.CloudBlobContainer*
type: Constructor
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 93
package: com.microsoft.azure.storage.blob
summary: >-
<p>Creates an instance of the class using the specified URI. The blob URI should include a SAS token unless anonymous access is to be used.</p>
<p></p>
syntax:
content: public CloudBlobContainer(final URI uri)
parameters:
- id: uri
type: bac42120
description: <p>A <code>java.net.URI</code> object which represents the URI of the container.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.CloudBlobContainer(final URI,final StorageCredentials)
id: CloudBlobContainer(final URI,final StorageCredentials)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: CloudBlobContainer(final URI uri, final StorageCredentials credentials)
nameWithType: CloudBlobContainer.CloudBlobContainer(final URI uri, final StorageCredentials credentials)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.CloudBlobContainer(final URI uri, final StorageCredentials credentials)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.CloudBlobContainer*
type: Constructor
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 122
package: com.microsoft.azure.storage.blob
summary: >-
<p>Creates an instance of the class using the specified URI and credentials.</p>
<p></p>
syntax:
content: public CloudBlobContainer(final URI uri, final StorageCredentials credentials)
parameters:
- id: uri
type: bac42120
description: <p>A <code>java.net.URI</code> object that represents the absolute URI of the container. </p>
- id: credentials
type: 93de0ef9com.microsoft.azure.storage._storage_credentials
description: <p>A <xref uid="com.microsoft.azure.storage._storage_credentials" data-throw-if-not-resolved="false">StorageCredentials</xref> object used to authenticate access.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.create()
id: create()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: create()
nameWithType: CloudBlobContainer.create()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.create()
overload: com.microsoft.azure.storage.blob._cloud_blob_container.create*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 180
package: com.microsoft.azure.storage.blob
summary: >-
<p>Creates the container.</p>
<p></p>
syntax:
content: public void create()
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.create(BlobContainerPublicAccessType,BlobRequestOptions,OperationContext)
id: create(BlobContainerPublicAccessType,BlobRequestOptions,OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: create(BlobContainerPublicAccessType accessType, BlobRequestOptions options, OperationContext opContext)
nameWithType: CloudBlobContainer.create(BlobContainerPublicAccessType accessType, BlobRequestOptions options, OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.create(BlobContainerPublicAccessType accessType, BlobRequestOptions options, OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.create*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 223
package: com.microsoft.azure.storage.blob
summary: >-
<p>Creates the container using the specified options and operation context.</p>
<p></p>
syntax:
content: public void create(BlobContainerPublicAccessType accessType, BlobRequestOptions options, OperationContext opContext)
parameters:
- id: accessType
type: com.microsoft.azure.storage.blob._blob_container_public_access_type
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_container_public_access_type" data-throw-if-not-resolved="false">BlobContainerPublicAccessType</xref> object that specifies whether data in the container may be accessed publicly and what level of access is to be allowed. </p>
- id: options
type: com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client ( <xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>). </p>
- id: opContext
type: com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.create(BlobRequestOptions,OperationContext)
id: create(BlobRequestOptions,OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: create(BlobRequestOptions options, OperationContext opContext)
nameWithType: CloudBlobContainer.create(BlobRequestOptions options, OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.create(BlobRequestOptions options, OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.create*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 200
package: com.microsoft.azure.storage.blob
summary: >-
<p>Creates the container using the specified options and operation context.</p>
<p></p>
syntax:
content: public void create(BlobRequestOptions options, OperationContext opContext)
parameters:
- id: options
type: com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client ( <xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>). </p>
- id: opContext
type: com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.createIfNotExists()
id: createIfNotExists()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: createIfNotExists()
nameWithType: CloudBlobContainer.createIfNotExists()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.createIfNotExists()
overload: com.microsoft.azure.storage.blob._cloud_blob_container.createIfNotExists*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 299
package: com.microsoft.azure.storage.blob
summary: >-
<p>Creates the container if it does not exist.</p>
<p></p>
syntax:
content: public boolean createIfNotExists()
return:
type: 4fc6e284
description: >-
<p>
<code>true</code> if the container did not already exist and was created; otherwise, <code>false</code>.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.createIfNotExists(BlobContainerPublicAccessType,BlobRequestOptions,OperationContext)
id: createIfNotExists(BlobContainerPublicAccessType,BlobRequestOptions,OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: createIfNotExists(BlobContainerPublicAccessType accessType, BlobRequestOptions options, OperationContext opContext)
nameWithType: CloudBlobContainer.createIfNotExists(BlobContainerPublicAccessType accessType, BlobRequestOptions options, OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.createIfNotExists(BlobContainerPublicAccessType accessType, BlobRequestOptions options, OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.createIfNotExists*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 346
package: com.microsoft.azure.storage.blob
summary: >-
<p>Creates the container if it does not exist, using the specified request options and operation context.</p>
<p></p>
syntax:
content: public boolean createIfNotExists(BlobContainerPublicAccessType accessType, BlobRequestOptions options, OperationContext opContext)
parameters:
- id: accessType
type: com.microsoft.azure.storage.blob._blob_container_public_access_type
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_container_public_access_type" data-throw-if-not-resolved="false">BlobContainerPublicAccessType</xref> object that specifies whether data in the container may be accessed publicly and what level of access is to be allowed. </p>
- id: options
type: com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client (<xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>). </p>
- id: opContext
type: com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.</p>
return:
type: 4fc6e284
description: >-
<p>
<code>true</code> if the container did not already exist and was created; otherwise, <code>false</code>.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.createIfNotExists(BlobRequestOptions,OperationContext)
id: createIfNotExists(BlobRequestOptions,OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: createIfNotExists(BlobRequestOptions options, OperationContext opContext)
nameWithType: CloudBlobContainer.createIfNotExists(BlobRequestOptions options, OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.createIfNotExists(BlobRequestOptions options, OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.createIfNotExists*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 321
package: com.microsoft.azure.storage.blob
summary: >-
<p>Creates the container if it does not exist, using the specified request options and operation context.</p>
<p></p>
syntax:
content: public boolean createIfNotExists(BlobRequestOptions options, OperationContext opContext)
parameters:
- id: options
type: com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client (<xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>). </p>
- id: opContext
type: com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.</p>
return:
type: 4fc6e284
description: >-
<p>
<code>true</code> if the container did not already exist and was created; otherwise, <code>false</code>.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.delete()
id: delete()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: delete()
nameWithType: CloudBlobContainer.delete()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.delete()
overload: com.microsoft.azure.storage.blob._cloud_blob_container.delete*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 381
package: com.microsoft.azure.storage.blob
summary: >-
<p>Deletes the container.</p>
<p></p>
syntax:
content: public void delete()
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.delete(AccessCondition,BlobRequestOptions,OperationContext)
id: delete(AccessCondition,BlobRequestOptions,OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: delete(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
nameWithType: CloudBlobContainer.delete(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.delete(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.delete*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 403
package: com.microsoft.azure.storage.blob
summary: >-
<p>Deletes the container using the specified request options and operation context.</p>
<p></p>
syntax:
content: public void delete(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
parameters:
- id: accessCondition
type: com.microsoft.azure.storage._access_condition
description: <p>An <xref uid="com.microsoft.azure.storage._access_condition" data-throw-if-not-resolved="false">AccessCondition</xref> object that represents the access conditions for the container. </p>
- id: options
type: com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client ( <xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>). </p>
- id: opContext
type: com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.deleteIfExists()
id: deleteIfExists()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: deleteIfExists()
nameWithType: CloudBlobContainer.deleteIfExists()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.deleteIfExists()
overload: com.microsoft.azure.storage.blob._cloud_blob_container.deleteIfExists*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 456
package: com.microsoft.azure.storage.blob
summary: >-
<p>Deletes the container if it exists.</p>
<p></p>
syntax:
content: public boolean deleteIfExists()
return:
type: 4fc6e284
description: >-
<p>
<code>true</code> if the container did not already exist and was created; otherwise, <code>false</code>.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.deleteIfExists(AccessCondition,BlobRequestOptions,OperationContext)
id: deleteIfExists(AccessCondition,BlobRequestOptions,OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: deleteIfExists(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
nameWithType: CloudBlobContainer.deleteIfExists(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.deleteIfExists(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.deleteIfExists*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 480
package: com.microsoft.azure.storage.blob
summary: >-
<p>Deletes the container if it exists using the specified request options and operation context.</p>
<p></p>
syntax:
content: public boolean deleteIfExists(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
parameters:
- id: accessCondition
type: com.microsoft.azure.storage._access_condition
description: <p>An <xref uid="com.microsoft.azure.storage._access_condition" data-throw-if-not-resolved="false">AccessCondition</xref> object that represents the access conditions for the container. </p>
- id: options
type: com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client ( <xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>). </p>
- id: opContext
type: com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.</p>
return:
type: 4fc6e284
description: >-
<p>
<code>true</code> if the container existed and was deleted; otherwise, <code>false</code>.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.downloadAccountInfo()
id: downloadAccountInfo()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: downloadAccountInfo()
nameWithType: CloudBlobContainer.downloadAccountInfo()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.downloadAccountInfo()
overload: com.microsoft.azure.storage.blob._cloud_blob_container.downloadAccountInfo*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 2379
package: com.microsoft.azure.storage.blob
summary: >-
<p>Gets information related to the storage account in which this container resides.</p>
<p></p>
syntax:
content: public AccountInformation downloadAccountInfo()
return:
type: com.microsoft.azure.storage._account_information
description: <p>A <xref uid="com.microsoft.azure.storage._account_information" data-throw-if-not-resolved="false">AccountInformation</xref> object for the given storage account. </p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.downloadAccountInfo(BlobRequestOptions,OperationContext)
id: downloadAccountInfo(BlobRequestOptions,OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: downloadAccountInfo(BlobRequestOptions options, OperationContext opContext)
nameWithType: CloudBlobContainer.downloadAccountInfo(BlobRequestOptions options, OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.downloadAccountInfo(BlobRequestOptions options, OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.downloadAccountInfo*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 2401
package: com.microsoft.azure.storage.blob
summary: >-
<p>Gets information related to the storage account in which this container resides.</p>
<p></p>
syntax:
content: public AccountInformation downloadAccountInfo(BlobRequestOptions options, OperationContext opContext)
parameters:
- id: options
type: com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client ( <xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>). </p>
- id: opContext
type: com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.</p>
return:
type: com.microsoft.azure.storage._account_information
description: <p>A <xref uid="com.microsoft.azure.storage._account_information" data-throw-if-not-resolved="false">AccountInformation</xref> object for the given storage account.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.downloadAccountInformationImpl(final RequestOptions)
id: downloadAccountInformationImpl(final RequestOptions)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: downloadAccountInformationImpl(final RequestOptions options)
nameWithType: CloudBlobContainer.downloadAccountInformationImpl(final RequestOptions options)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.downloadAccountInformationImpl(final RequestOptions options)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.downloadAccountInformationImpl*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 2413
package: com.microsoft.azure.storage.blob
syntax:
content: protected StorageRequest<ServiceClient, CloudBlobContainer, AccountInformation> downloadAccountInformationImpl(final RequestOptions options)
parameters:
- id: options
type: 93de0ef9com.microsoft.azure.storage._request_options
return:
type: com.microsoft.azure.storage.core._storage_request78504a52com.microsoft.azure.storage._service_clientb33c76fccom.microsoft.azure.storage.blob._cloud_blob_containerb33c76fccom.microsoft.azure.storage._account_informationa08ddfce
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.downloadAttributes()
id: downloadAttributes()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: downloadAttributes()
nameWithType: CloudBlobContainer.downloadAttributes()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.downloadAttributes()
overload: com.microsoft.azure.storage.blob._cloud_blob_container.downloadAttributes*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 512
package: com.microsoft.azure.storage.blob
summary: >-
<p>Downloads the container's attributes, which consist of metadata and properties.</p>
<p></p>
syntax: &o1
content: public void downloadAttributes()
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.downloadAttributes(AccessCondition,BlobRequestOptions,OperationContext)
id: downloadAttributes(AccessCondition,BlobRequestOptions,OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: downloadAttributes(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
nameWithType: CloudBlobContainer.downloadAttributes(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.downloadAttributes(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.downloadAttributes*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 535
package: com.microsoft.azure.storage.blob
summary: >-
<p>Downloads the container's attributes, which consist of metadata and properties, using the specified request options and operation context.</p>
<p></p>
syntax:
content: public void downloadAttributes(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
parameters:
- id: accessCondition
type: com.microsoft.azure.storage._access_condition
description: <p>An <xref uid="com.microsoft.azure.storage._access_condition" data-throw-if-not-resolved="false">AccessCondition</xref> object that represents the access conditions for the container. </p>
- id: options
type: com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client ( <xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>). </p>
- id: opContext
type: com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.downloadPermissions()
id: downloadPermissions()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: downloadPermissions()
nameWithType: CloudBlobContainer.downloadPermissions()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.downloadPermissions()
overload: com.microsoft.azure.storage.blob._cloud_blob_container.downloadPermissions*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 602
package: com.microsoft.azure.storage.blob
summary: >-
<p>Downloads the permission settings for the container.</p>
<p></p>
syntax:
content: public BlobContainerPermissions downloadPermissions()
return:
type: com.microsoft.azure.storage.blob._blob_container_permissions
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_container_permissions" data-throw-if-not-resolved="false">BlobContainerPermissions</xref> object that represents the container's permissions.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.downloadPermissions(AccessCondition,BlobRequestOptions,OperationContext)
id: downloadPermissions(AccessCondition,BlobRequestOptions,OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: downloadPermissions(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
nameWithType: CloudBlobContainer.downloadPermissions(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.downloadPermissions(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.downloadPermissions*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 626
package: com.microsoft.azure.storage.blob
summary: >-
<p>Downloads the permissions settings for the container using the specified request options and operation context.</p>
<p></p>
syntax:
content: public BlobContainerPermissions downloadPermissions(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
parameters:
- id: accessCondition
type: com.microsoft.azure.storage._access_condition
description: <p>An <xref uid="com.microsoft.azure.storage._access_condition" data-throw-if-not-resolved="false">AccessCondition</xref> object that represents the access conditions for the container. </p>
- id: options
type: com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client ( <xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>). </p>
- id: opContext
type: com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.</p>
return:
type: com.microsoft.azure.storage.blob._blob_container_permissions
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_container_permissions" data-throw-if-not-resolved="false">BlobContainerPermissions</xref> object that represents the container's permissions.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.exists()
id: exists()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: exists()
nameWithType: CloudBlobContainer.exists()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.exists()
overload: com.microsoft.azure.storage.blob._cloud_blob_container.exists*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 703
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns a value that indicates whether the container exists.</p>
<p></p>
syntax:
content: public boolean exists()
return:
type: 4fc6e284
description: >-
<p>
<code>true</code> if the container exists, otherwise <code>false</code>.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.exists(final AccessCondition,BlobRequestOptions,OperationContext)
id: exists(final AccessCondition,BlobRequestOptions,OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: exists(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
nameWithType: CloudBlobContainer.exists(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.exists(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.exists*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 728
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns a value that indicates whether the container exists, using the specified request options and operation context.</p>
<p></p>
syntax:
content: public boolean exists(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
parameters:
- id: accessCondition
type: 93de0ef9com.microsoft.azure.storage._access_condition
description: <p>An <xref uid="com.microsoft.azure.storage._access_condition" data-throw-if-not-resolved="false">AccessCondition</xref> object that represents the access conditions for the container. </p>
- id: options
type: com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client ( <xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>). </p>
- id: opContext
type: com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.</p>
return:
type: 4fc6e284
description: >-
<p>
<code>true</code> if the container exists, otherwise <code>false</code>.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.generateSharedAccessSignature(final SharedAccessBlobPolicy,final String)
id: generateSharedAccessSignature(final SharedAccessBlobPolicy,final String)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: generateSharedAccessSignature(final SharedAccessBlobPolicy policy, final String groupPolicyIdentifier)
nameWithType: CloudBlobContainer.generateSharedAccessSignature(final SharedAccessBlobPolicy policy, final String groupPolicyIdentifier)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.generateSharedAccessSignature(final SharedAccessBlobPolicy policy, final String groupPolicyIdentifier)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.generateSharedAccessSignature*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 814
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns a shared access signature for the container. Note this does not contain the leading "?".</p>
<p></p>
syntax:
content: public String generateSharedAccessSignature(final SharedAccessBlobPolicy policy, final String groupPolicyIdentifier)
parameters:
- id: policy
type: 93de0ef9com.microsoft.azure.storage.blob._shared_access_blob_policy
description: <p>An <xref uid="com.microsoft.azure.storage.blob._shared_access_blob_policy" data-throw-if-not-resolved="false">SharedAccessBlobPolicy</xref> object that represents the access policy for the shared access signature. </p>
- id: groupPolicyIdentifier
type: 3d93591e
description: <p>A <code>String</code> which represents the container-level access policy.</p>
return:
type: "26831127"
description: <p>A <code>String</code> which represents a shared access signature for the container.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- type: e333ca4f
description: <p>If the key is invalid. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.generateSharedAccessSignature(final SharedAccessBlobPolicy,final String,final IPRange,final SharedAccessProtocols)
id: generateSharedAccessSignature(final SharedAccessBlobPolicy,final String,final IPRange,final SharedAccessProtocols)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: generateSharedAccessSignature(final SharedAccessBlobPolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)
nameWithType: CloudBlobContainer.generateSharedAccessSignature(final SharedAccessBlobPolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.generateSharedAccessSignature(final SharedAccessBlobPolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.generateSharedAccessSignature*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 841
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns a shared access signature for the container. Note this does not contain the leading "?".</p>
<p></p>
syntax:
content: public String generateSharedAccessSignature(final SharedAccessBlobPolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)
parameters:
- id: policy
type: 93de0ef9com.microsoft.azure.storage.blob._shared_access_blob_policy
description: <p>An <xref uid="com.microsoft.azure.storage.blob._shared_access_blob_policy" data-throw-if-not-resolved="false">SharedAccessBlobPolicy</xref> object that represents the access policy for the shared access signature. </p>
- id: groupPolicyIdentifier
type: 3d93591e
description: <p>A <code>String</code> which represents the container-level access policy. </p>
- id: ipRange
type: 93de0ef9com.microsoft.azure.storage._i_p_range
description: <p>A <xref uid="com.microsoft.azure.storage._i_p_range" data-throw-if-not-resolved="false">IPRange</xref> object containing the range of allowed IP addresses. </p>
- id: protocols
type: 93de0ef9com.microsoft.azure.storage._shared_access_protocols
description: <p>A <xref uid="com.microsoft.azure.storage._shared_access_protocols" data-throw-if-not-resolved="false">SharedAccessProtocols</xref> representing the allowed Internet protocols.</p>
return:
type: "26831127"
description: <p>A <code>String</code> which represents a shared access signature for the container.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- type: e333ca4f
description: <p>If the key is invalid. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getAppendBlobReference(final String)
id: getAppendBlobReference(final String)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: getAppendBlobReference(final String blobName)
nameWithType: CloudBlobContainer.getAppendBlobReference(final String blobName)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getAppendBlobReference(final String blobName)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.getAppendBlobReference*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 874
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns a reference to a <xref uid="com.microsoft.azure.storage.blob._cloud_append_blob" data-throw-if-not-resolved="false">CloudAppendBlob</xref> object that represents an append blob in this container.</p>
<p></p>
syntax:
content: public CloudAppendBlob getAppendBlobReference(final String blobName)
parameters:
- id: blobName
type: 3d93591e
description: <p>A <code>String</code> that represents the name of the blob.</p>
return:
type: com.microsoft.azure.storage.blob._cloud_append_blob
description: <p>A <xref uid="com.microsoft.azure.storage.blob._cloud_append_blob" data-throw-if-not-resolved="false">CloudAppendBlob</xref> object that represents a reference to the specified append blob.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- type: "44102508"
description: <p>If the resource URI is invalid. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getAppendBlobReference(final String,final String)
id: getAppendBlobReference(final String,final String)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: getAppendBlobReference(final String blobName, final String snapshotID)
nameWithType: CloudBlobContainer.getAppendBlobReference(final String blobName, final String snapshotID)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getAppendBlobReference(final String blobName, final String snapshotID)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.getAppendBlobReference*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 894
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns a reference to a <xref uid="com.microsoft.azure.storage.blob._cloud_append_blob" data-throw-if-not-resolved="false">CloudAppendBlob</xref> object that represents an append blob in the container, using the specified snapshot ID.</p>
<p></p>
syntax:
content: public CloudAppendBlob getAppendBlobReference(final String blobName, final String snapshotID)
parameters:
- id: blobName
type: 3d93591e
description: <p>A <code>String</code> that represents the name of the blob. </p>
- id: snapshotID
type: 3d93591e
description: <p>A <code>String</code> that represents the snapshot ID of the blob.</p>
return:
type: com.microsoft.azure.storage.blob._cloud_append_blob
description: <p>A <xref uid="com.microsoft.azure.storage.blob._cloud_append_blob" data-throw-if-not-resolved="false">CloudAppendBlob</xref> object that represents a reference to the specified append blob.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- type: "44102508"
description: <p>If the resource URI is invalid. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getBlobReferenceFromServer(final String)
id: getBlobReferenceFromServer(final String)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: getBlobReferenceFromServer(final String blobName)
nameWithType: CloudBlobContainer.getBlobReferenceFromServer(final String blobName)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getBlobReferenceFromServer(final String blobName)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.getBlobReferenceFromServer*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 980
package: com.microsoft.azure.storage.blob
summary: >-
<p>Gets a reference to a blob in this container. The blob must already exist on the service.</p>
<p>Unlike the other get*Reference methods, this method does a service request to retrieve the blob's metadata and properties. The returned blob may be used directly as a CloudBlob or cast using either instanceof or getProperties().getBlobType() to determine its subtype.</p>
<p></p>
syntax:
content: public final CloudBlob getBlobReferenceFromServer(final String blobName)
parameters:
- id: blobName
type: 3d93591e
description: <p>A <code>String</code> that represents the name of the blob.</p>
return:
type: 93de0ef9com.microsoft.azure.storage.blob._cloud_blob
description: <p>A <xref uid="com.microsoft.azure.storage.blob._cloud_blob" data-throw-if-not-resolved="false">CloudBlob</xref> object that represents a reference to the specified blob.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- type: "44102508"
description: <p>If the resource URI is invalid. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getBlobReferenceFromServer(final String,final String,AccessCondition,BlobRequestOptions,OperationContext)
id: getBlobReferenceFromServer(final String,final String,AccessCondition,BlobRequestOptions,OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: getBlobReferenceFromServer(final String blobName, final String snapshotID, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
nameWithType: CloudBlobContainer.getBlobReferenceFromServer(final String blobName, final String snapshotID, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getBlobReferenceFromServer(final String blobName, final String snapshotID, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.getBlobReferenceFromServer*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1014
package: com.microsoft.azure.storage.blob
summary: >-
<p>Gets a reference to a blob in this container. The blob must already exist on the service.</p>
<p>Unlike the other get*Reference methods, this method does a service request to retrieve the blob's metadata and properties. The returned blob may be used directly as a CloudBlob or cast using either instanceof or getProperties().getBlobType() to determine its subtype.</p>
<p></p>
syntax:
content: public final CloudBlob getBlobReferenceFromServer(final String blobName, final String snapshotID, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
parameters:
- id: blobName
type: 3d93591e
description: <p>A <code>String</code> that represents the name of the blob. </p>
- id: snapshotID
type: 3d93591e
description: <p>A <code>String</code> that represents the snapshot ID of the blob. </p>
- id: accessCondition
type: com.microsoft.azure.storage._access_condition
description: <p>An <xref uid="com.microsoft.azure.storage._access_condition" data-throw-if-not-resolved="false">AccessCondition</xref> object that represents the access conditions for the blob. </p>
- id: options
type: com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client ( <xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>). </p>
- id: opContext
type: com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.</p>
return:
type: 93de0ef9com.microsoft.azure.storage.blob._cloud_blob
description: <p>A <xref uid="com.microsoft.azure.storage.blob._cloud_blob" data-throw-if-not-resolved="false">CloudBlob</xref> object that represents a reference to the specified blob.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- type: "44102508"
description: <p>If the resource URI is invalid. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getBlockBlobReference(final String)
id: getBlockBlobReference(final String)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: getBlockBlobReference(final String blobName)
nameWithType: CloudBlobContainer.getBlockBlobReference(final String blobName)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getBlockBlobReference(final String blobName)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.getBlockBlobReference*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 912
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns a reference to a <xref uid="com.microsoft.azure.storage.blob._cloud_block_blob" data-throw-if-not-resolved="false">CloudBlockBlob</xref> object that represents a block blob in this container.</p>
<p></p>
syntax:
content: public CloudBlockBlob getBlockBlobReference(final String blobName)
parameters:
- id: blobName
type: 3d93591e
description: <p>A <code>String</code> that represents the name of the blob.</p>
return:
type: com.microsoft.azure.storage.blob._cloud_block_blob
description: <p>A <xref uid="com.microsoft.azure.storage.blob._cloud_block_blob" data-throw-if-not-resolved="false">CloudBlockBlob</xref> object that represents a reference to the specified block blob.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- type: "44102508"
description: <p>If the resource URI is invalid. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getBlockBlobReference(final String,final String)
id: getBlockBlobReference(final String,final String)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: getBlockBlobReference(final String blobName, final String snapshotID)
nameWithType: CloudBlobContainer.getBlockBlobReference(final String blobName, final String snapshotID)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getBlockBlobReference(final String blobName, final String snapshotID)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.getBlockBlobReference*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 932
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns a reference to a <xref uid="com.microsoft.azure.storage.blob._cloud_block_blob" data-throw-if-not-resolved="false">CloudBlockBlob</xref> object that represents a block blob in this container, using the specified snapshot ID.</p>
<p></p>
syntax:
content: public CloudBlockBlob getBlockBlobReference(final String blobName, final String snapshotID)
parameters:
- id: blobName
type: 3d93591e
description: <p>A <code>String</code> that represents the name of the blob. </p>
- id: snapshotID
type: 3d93591e
description: <p>A <code>String</code> that represents the snapshot ID of the blob.</p>
return:
type: com.microsoft.azure.storage.blob._cloud_block_blob
description: <p>A <xref uid="com.microsoft.azure.storage.blob._cloud_block_blob" data-throw-if-not-resolved="false">CloudBlockBlob</xref> object that represents a reference to the specified block blob.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- type: "44102508"
description: <p>If the resource URI is invalid. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getDirectoryReference(String)
id: getDirectoryReference(String)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: getDirectoryReference(String directoryName)
nameWithType: CloudBlobContainer.getDirectoryReference(String directoryName)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getDirectoryReference(String directoryName)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.getDirectoryReference*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 948
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns a reference to a <xref uid="com.microsoft.azure.storage.blob._cloud_blob_directory" data-throw-if-not-resolved="false">CloudBlobDirectory</xref> object that represents a virtual blob directory within this container.</p>
<p></p>
syntax:
content: public CloudBlobDirectory getDirectoryReference(String directoryName)
parameters:
- id: directoryName
type: "26831127"
description: <p>A <code>String</code> that represents the name of the virtual blob directory. If the root directory (the directory representing the container itself) is desired, use an empty string. </p>
return:
type: com.microsoft.azure.storage.blob._cloud_blob_directory
description: <p>A <xref uid="com.microsoft.azure.storage.blob._cloud_blob_directory" data-throw-if-not-resolved="false">CloudBlobDirectory</xref> that represents a virtual blob directory within this container. </p>
exceptions:
- type: "44102508"
description: <p>If the resource URI is invalid. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getMetadata()
id: getMetadata()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: getMetadata()
nameWithType: CloudBlobContainer.getMetadata()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getMetadata()
overload: com.microsoft.azure.storage.blob._cloud_blob_container.getMetadata*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1099
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns the metadata for the container. This value is initialized with the metadata from the queue by a call to <xref uid="com.microsoft.azure.storage.blob._cloud_blob_container.downloadAttributes()" data-throw-if-not-resolved="false">downloadAttributes</xref>, and is set on the queue with a call to <xref uid="com.microsoft.azure.storage.blob._cloud_blob_container.uploadMetadata()" data-throw-if-not-resolved="false">uploadMetadata</xref>.</p>
<p></p>
syntax:
content: public HashMap<String, String> getMetadata()
return:
type: 3970a053
description: <p>A <code>java.util.HashMap</code> object that represents the metadata for the container. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getName()
id: getName()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: getName()
nameWithType: CloudBlobContainer.getName()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getName()
overload: com.microsoft.azure.storage.blob._cloud_blob_container.getName*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1108
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns the name of the container.</p>
<p></p>
syntax:
content: public String getName()
return:
type: "26831127"
description: <p>A <code>String</code> that represents the name of the container. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getPageBlobReference(final String)
id: getPageBlobReference(final String)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: getPageBlobReference(final String blobName)
nameWithType: CloudBlobContainer.getPageBlobReference(final String blobName)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getPageBlobReference(final String blobName)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.getPageBlobReference*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1134
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns a reference to a <xref uid="com.microsoft.azure.storage.blob._cloud_page_blob" data-throw-if-not-resolved="false">CloudPageBlob</xref> object that represents a page blob in this container.</p>
<p></p>
syntax:
content: public CloudPageBlob getPageBlobReference(final String blobName)
parameters:
- id: blobName
type: 3d93591e
description: <p>A <code>String</code> that represents the name of the blob.</p>
return:
type: com.microsoft.azure.storage.blob._cloud_page_blob
description: <p>A <xref uid="com.microsoft.azure.storage.blob._cloud_page_blob" data-throw-if-not-resolved="false">CloudPageBlob</xref> object that represents a reference to the specified page blob.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- type: "44102508"
description: <p>If the resource URI is invalid. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getPageBlobReference(final String,final String)
id: getPageBlobReference(final String,final String)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: getPageBlobReference(final String blobName, final String snapshotID)
nameWithType: CloudBlobContainer.getPageBlobReference(final String blobName, final String snapshotID)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getPageBlobReference(final String blobName, final String snapshotID)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.getPageBlobReference*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1154
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns a reference to a <xref uid="com.microsoft.azure.storage.blob._cloud_page_blob" data-throw-if-not-resolved="false">CloudPageBlob</xref> object that represents a page blob in the container, using the specified snapshot ID.</p>
<p></p>
syntax:
content: public CloudPageBlob getPageBlobReference(final String blobName, final String snapshotID)
parameters:
- id: blobName
type: 3d93591e
description: <p>A <code>String</code> that represents the name of the blob. </p>
- id: snapshotID
type: 3d93591e
description: <p>A <code>String</code> that represents the snapshot ID of the blob.</p>
return:
type: com.microsoft.azure.storage.blob._cloud_page_blob
description: <p>A <xref uid="com.microsoft.azure.storage.blob._cloud_page_blob" data-throw-if-not-resolved="false">CloudPageBlob</xref> object that represents a reference to the specified page blob.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- type: "44102508"
description: <p>If the resource URI is invalid. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getProperties()
id: getProperties()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: getProperties()
nameWithType: CloudBlobContainer.getProperties()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getProperties()
overload: com.microsoft.azure.storage.blob._cloud_blob_container.getProperties*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1164
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns the properties for the container.</p>
<p></p>
syntax:
content: public BlobContainerProperties getProperties()
return:
type: com.microsoft.azure.storage.blob._blob_container_properties
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_container_properties" data-throw-if-not-resolved="false">BlobContainerProperties</xref> object that represents the properties for the container. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getServiceClient()
id: getServiceClient()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: getServiceClient()
nameWithType: CloudBlobContainer.getServiceClient()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getServiceClient()
overload: com.microsoft.azure.storage.blob._cloud_blob_container.getServiceClient*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1173
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns the Blob service client associated with this container.</p>
<p></p>
syntax:
content: public CloudBlobClient getServiceClient()
return:
type: com.microsoft.azure.storage.blob._cloud_blob_client
description: <p>A <xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref> object that represents the service client associated with this container. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getStorageUri()
id: getStorageUri()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: getStorageUri()
nameWithType: CloudBlobContainer.getStorageUri()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getStorageUri()
overload: com.microsoft.azure.storage.blob._cloud_blob_container.getStorageUri*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1117
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns the list of URIs for all locations.</p>
<p></p>
syntax:
content: public StorageUri getStorageUri()
return:
type: com.microsoft.azure.storage._storage_uri
description: <p>A <xref uid="com.microsoft.azure.storage._storage_uri" data-throw-if-not-resolved="false">StorageUri</xref> object which represents the list of URIs for all locations.. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getUri()
id: getUri()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: getUri()
nameWithType: CloudBlobContainer.getUri()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getUri()
overload: com.microsoft.azure.storage.blob._cloud_blob_container.getUri*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1211
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns the URI for this container.</p>
<p></p>
syntax:
content: public URI getUri()
return:
type: "62304784"
description: <p>The absolute URI to the container. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.listBlobs()
id: listBlobs()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: listBlobs()
nameWithType: CloudBlobContainer.listBlobs()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.listBlobs()
overload: com.microsoft.azure.storage.blob._cloud_blob_container.listBlobs*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1222
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns an enumerable collection of blob items for the container.</p>
<p></p>
syntax:
content: public Iterable<ListBlobItem> listBlobs()
return:
type: 2a13b5a5com.microsoft.azure.storage.blob._list_blob_itema08ddfce
description: <p>An enumerable collection of <xref uid="com.microsoft.azure.storage.blob._list_blob_item" data-throw-if-not-resolved="false">ListBlobItem</xref> objects retrieved lazily that represents the items in this container. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.listBlobs(final String)
id: listBlobs(final String)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: listBlobs(final String prefix)
nameWithType: CloudBlobContainer.listBlobs(final String prefix)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.listBlobs(final String prefix)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.listBlobs*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1237
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns an enumerable collection of blob items for the container whose names begin with the specified prefix.</p>
<p></p>
syntax:
content: public Iterable<ListBlobItem> listBlobs(final String prefix)
parameters:
- id: prefix
type: 3d93591e
description: <p>A <code>String</code> that represents the blob name prefix. This value must be preceded either by the name of the container or by the absolute path to the container.</p>
return:
type: 2a13b5a5com.microsoft.azure.storage.blob._list_blob_itema08ddfce
description: <p>An enumerable collection of <xref uid="com.microsoft.azure.storage.blob._list_blob_item" data-throw-if-not-resolved="false">ListBlobItem</xref> objects retrieved lazily that represents the items whose names begin with the specified prefix in this container. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.listBlobs(final String,final boolean)
id: listBlobs(final String,final boolean)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: listBlobs(final String prefix, final boolean useFlatBlobListing)
nameWithType: CloudBlobContainer.listBlobs(final String prefix, final boolean useFlatBlobListing)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.listBlobs(final String prefix, final boolean useFlatBlobListing)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.listBlobs*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1255
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns an enumerable collection of blob items for the container whose names begin with the specified prefix using the specified flat or hierarchical option.</p>
<p></p>
syntax:
content: public Iterable<ListBlobItem> listBlobs(final String prefix, final boolean useFlatBlobListing)
parameters:
- id: prefix
type: 3d93591e
description: <p>A <code>String</code> that represents the blob name prefix. This value must be preceded either by the name of the container or by the absolute path to the container. </p>
- id: useFlatBlobListing
type: 4dda0764
description: >-
<p>
<code>true</code> to indicate that the returned list will be flat; <code>false</code> to indicate that the returned list will be hierarchical. </p>
return:
type: 2a13b5a5com.microsoft.azure.storage.blob._list_blob_itema08ddfce
description: <p>An enumerable collection of <xref uid="com.microsoft.azure.storage.blob._list_blob_item" data-throw-if-not-resolved="false">ListBlobItem</xref> objects retrieved lazily that represents the items whose names begin with the specified prefix in this container. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.listBlobs(final String,final boolean,final EnumSet<BlobListingDetails>,BlobRequestOptions,OperationContext)
id: listBlobs(final String,final boolean,final EnumSet<BlobListingDetails>,BlobRequestOptions,OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: listBlobs(final String prefix, final boolean useFlatBlobListing, final EnumSet<BlobListingDetails> listingDetails, BlobRequestOptions options, OperationContext opContext)
nameWithType: CloudBlobContainer.listBlobs(final String prefix, final boolean useFlatBlobListing, final EnumSet<BlobListingDetails> listingDetails, BlobRequestOptions options, OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.listBlobs(final String prefix, final boolean useFlatBlobListing, final EnumSet<BlobListingDetails> listingDetails, BlobRequestOptions options, OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.listBlobs*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1285
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns an enumerable collection of blob items for the container whose names begin with the specified prefix, using the specified flat or hierarchical option, listing details options, request options, and operation context.</p>
<p></p>
syntax:
content: public Iterable<ListBlobItem> listBlobs(final String prefix, final boolean useFlatBlobListing, final EnumSet<BlobListingDetails> listingDetails, BlobRequestOptions options, OperationContext opContext)
parameters:
- id: prefix
type: 3d93591e
description: <p>A <code>String</code> that represents the blob name prefix. This value must be preceded either by the name of the container or by the absolute path to the container. </p>
- id: useFlatBlobListing
type: 4dda0764
description: >-
<p>
<code>true</code> to indicate that the returned list will be flat; <code>false</code> to indicate that the returned list will be hierarchical. </p>
- id: listingDetails
type: 7f216280com.microsoft.azure.storage.blob._blob_listing_detailsa08ddfce
description: <p>A <code>java.util.EnumSet</code> object that contains <xref uid="com.microsoft.azure.storage.blob._blob_listing_details" data-throw-if-not-resolved="false">BlobListingDetails</xref> values that indicate whether snapshots, soft-deleted blobs, metadata, and/or uncommitted blocks are returned. Committed blocks are always returned. </p>
- id: options
type: com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client ( <xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>). </p>
- id: opContext
type: com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation. </p>
return:
type: 2a13b5a5com.microsoft.azure.storage.blob._list_blob_itema08ddfce
description: <p>An enumerable collection of <xref uid="com.microsoft.azure.storage.blob._list_blob_item" data-throw-if-not-resolved="false">ListBlobItem</xref> objects retrieved lazily that represents the items whose names begin with the specified prefix in this container. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.listBlobsSegmented()
id: listBlobsSegmented()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: listBlobsSegmented()
nameWithType: CloudBlobContainer.listBlobsSegmented()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.listBlobsSegmented()
overload: com.microsoft.azure.storage.blob._cloud_blob_container.listBlobsSegmented*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1315
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns a result segment of an enumerable collection of blob items in the container.</p>
<p></p>
syntax:
content: public ResultSegment<ListBlobItem> listBlobsSegmented()
return:
type: com.microsoft.azure.storage._result_segment78504a52com.microsoft.azure.storage.blob._list_blob_itema08ddfce
description: <p>A <xref uid="com.microsoft.azure.storage._result_segment" data-throw-if-not-resolved="false">ResultSegment</xref> object that contains a segment of the enumerable collection of <xref uid="com.microsoft.azure.storage.blob._list_blob_item" data-throw-if-not-resolved="false">ListBlobItem</xref> objects that represent the blob items in the container.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.listBlobsSegmented(final String)
id: listBlobsSegmented(final String)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: listBlobsSegmented(final String prefix)
nameWithType: CloudBlobContainer.listBlobsSegmented(final String prefix)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.listBlobsSegmented(final String prefix)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.listBlobsSegmented*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1333
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns a result segment containing a collection of blob items whose names begin with the specified prefix.</p>
<p></p>
syntax:
content: public ResultSegment<ListBlobItem> listBlobsSegmented(final String prefix)
parameters:
- id: prefix
type: 3d93591e
description: <p>A <code>String</code> that represents the prefix of the blob name.</p>
return:
type: com.microsoft.azure.storage._result_segment78504a52com.microsoft.azure.storage.blob._list_blob_itema08ddfce
description: <p>A <xref uid="com.microsoft.azure.storage._result_segment" data-throw-if-not-resolved="false">ResultSegment</xref> object that contains a segment of the enumerable collection of <xref uid="com.microsoft.azure.storage.blob._list_blob_item" data-throw-if-not-resolved="false">ListBlobItem</xref> objects that represent the blob items whose names begin with the specified prefix in the container.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.listBlobsSegmented(final String,final boolean,final EnumSet<BlobListingDetails>,final Integer,final ResultContinuation,BlobRequestOptions,OperationContext)
id: listBlobsSegmented(final String,final boolean,final EnumSet<BlobListingDetails>,final Integer,final ResultContinuation,BlobRequestOptions,OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: listBlobsSegmented(final String prefix, final boolean useFlatBlobListing, final EnumSet<BlobListingDetails> listingDetails, final Integer maxResults, final ResultContinuation continuationToken, BlobRequestOptions options, OperationContext opContext)
nameWithType: CloudBlobContainer.listBlobsSegmented(final String prefix, final boolean useFlatBlobListing, final EnumSet<BlobListingDetails> listingDetails, final Integer maxResults, final ResultContinuation continuationToken, BlobRequestOptions options, OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.listBlobsSegmented(final String prefix, final boolean useFlatBlobListing, final EnumSet<BlobListingDetails> listingDetails, final Integer maxResults, final ResultContinuation continuationToken, BlobRequestOptions options, OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.listBlobsSegmented*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1374
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns a result segment containing a collection of blob items whose names begin with the specified prefix, using the specified flat or hierarchical option, listing details options, request options, and operation context.</p>
<p></p>
syntax:
content: public ResultSegment<ListBlobItem> listBlobsSegmented(final String prefix, final boolean useFlatBlobListing, final EnumSet<BlobListingDetails> listingDetails, final Integer maxResults, final ResultContinuation continuationToken, BlobRequestOptions options, OperationContext opContext)
parameters:
- id: prefix
type: 3d93591e
description: <p>A <code>String</code> that represents the prefix of the blob name. </p>
- id: useFlatBlobListing
type: 4dda0764
description: >-
<p>
<code>true</code> to indicate that the returned list will be flat; <code>false</code> to indicate that the returned list will be hierarchical. </p>
- id: listingDetails
type: 7f216280com.microsoft.azure.storage.blob._blob_listing_detailsa08ddfce
description: <p>A <code>java.util.EnumSet</code> object that contains <xref uid="com.microsoft.azure.storage.blob._blob_listing_details" data-throw-if-not-resolved="false">BlobListingDetails</xref> values that indicate whether snapshots, soft-deleted blobs, metadata, and/or uncommitted blocks are returned. Committed blocks are always returned. </p>
- id: maxResults
type: 3437983f
description: <p>The maximum number of results to retrieve. If <code>null</code> or greater than 5000, the server will return up to 5,000 items. Must be at least 1. </p>
- id: continuationToken
type: 93de0ef9com.microsoft.azure.storage._result_continuation
description: <p>A <xref uid="com.microsoft.azure.storage._result_continuation" data-throw-if-not-resolved="false">ResultContinuation</xref> object that represents a continuation token returned by a previous listing operation. </p>
- id: options
type: com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client (<xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>). </p>
- id: opContext
type: com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.</p>
return:
type: com.microsoft.azure.storage._result_segment78504a52com.microsoft.azure.storage.blob._list_blob_itema08ddfce
description: <p>A <xref uid="com.microsoft.azure.storage._result_segment" data-throw-if-not-resolved="false">ResultSegment</xref> object that contains a segment of the enumerable collection of <xref uid="com.microsoft.azure.storage.blob._list_blob_item" data-throw-if-not-resolved="false">ListBlobItem</xref> objects that represent the block items whose names begin with the specified prefix in the container.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.listContainers()
id: listContainers()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: listContainers()
nameWithType: CloudBlobContainer.listContainers()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.listContainers()
overload: com.microsoft.azure.storage.blob._cloud_blob_container.listContainers*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1478
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns an enumerable collection of containers for the service client associated with this container.</p>
<p></p>
syntax:
content: public Iterable<CloudBlobContainer> listContainers()
return:
type: 2a13b5a5com.microsoft.azure.storage.blob._cloud_blob_containera08ddfce
description: <p>An enumerable collection of <xref uid="com.microsoft.azure.storage.blob._cloud_blob_container" data-throw-if-not-resolved="false">CloudBlobContainer</xref> objects retrieved lazily that represent the containers for the service client associated with this container. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.listContainers(final String)
id: listContainers(final String)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: listContainers(final String prefix)
nameWithType: CloudBlobContainer.listContainers(final String prefix)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.listContainers(final String prefix)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.listContainers*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1494
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns an enumerable collection of containers whose names begin with the specified prefix for the service client associated with this container.</p>
<p></p>
syntax:
content: public Iterable<CloudBlobContainer> listContainers(final String prefix)
parameters:
- id: prefix
type: 3d93591e
description: <p>A <code>String</code> that represents the container name prefix.</p>
return:
type: 2a13b5a5com.microsoft.azure.storage.blob._cloud_blob_containera08ddfce
description: <p>An enumerable collection of <xref uid="com.microsoft.azure.storage.blob._cloud_blob_container" data-throw-if-not-resolved="false">CloudBlobContainer</xref> objects retrieved lazily that represent the containers whose names begin with the specified prefix for the service client associated with this container. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.listContainers(final String,final ContainerListingDetails,final BlobRequestOptions,final OperationContext)
id: listContainers(final String,final ContainerListingDetails,final BlobRequestOptions,final OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: listContainers(final String prefix, final ContainerListingDetails detailsIncluded, final BlobRequestOptions options, final OperationContext opContext)
nameWithType: CloudBlobContainer.listContainers(final String prefix, final ContainerListingDetails detailsIncluded, final BlobRequestOptions options, final OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.listContainers(final String prefix, final ContainerListingDetails detailsIncluded, final BlobRequestOptions options, final OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.listContainers*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1520
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns an enumerable collection of containers whose names begin with the specified prefix for the service client associated with this container, using the specified details setting, request options, and operation context.</p>
<p></p>
syntax:
content: public Iterable<CloudBlobContainer> listContainers(final String prefix, final ContainerListingDetails detailsIncluded, final BlobRequestOptions options, final OperationContext opContext)
parameters:
- id: prefix
type: 3d93591e
description: <p>A <code>String</code> that represents the container name prefix. </p>
- id: detailsIncluded
type: 93de0ef9com.microsoft.azure.storage.blob._container_listing_details
description: <p>A <xref uid="com.microsoft.azure.storage.blob._container_listing_details" data-throw-if-not-resolved="false">ContainerListingDetails</xref> value that indicates whether container metadata will be returned. </p>
- id: options
type: 93de0ef9com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client ( <xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>). </p>
- id: opContext
type: 93de0ef9com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.</p>
return:
type: 2a13b5a5com.microsoft.azure.storage.blob._cloud_blob_containera08ddfce
description: <p>An enumerable collection of <xref uid="com.microsoft.azure.storage.blob._cloud_blob_container" data-throw-if-not-resolved="false">CloudBlobContainer</xref> objects retrieved lazily that represents the containers for the service client associated with this container. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.listContainersSegmented()
id: listContainersSegmented()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: listContainersSegmented()
nameWithType: CloudBlobContainer.listContainersSegmented()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.listContainersSegmented()
overload: com.microsoft.azure.storage.blob._cloud_blob_container.listContainersSegmented*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1538
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns a result segment of an enumerable collection of containers for the service client associated with this container.</p>
<p></p>
syntax:
content: public ResultSegment<CloudBlobContainer> listContainersSegmented()
return:
type: com.microsoft.azure.storage._result_segment78504a52com.microsoft.azure.storage.blob._cloud_blob_containera08ddfce
description: <p>A <xref uid="com.microsoft.azure.storage._result_segment" data-throw-if-not-resolved="false">ResultSegment</xref> object that contains a segment of the enumerable collection of <xref uid="com.microsoft.azure.storage.blob._cloud_blob_container" data-throw-if-not-resolved="false">CloudBlobContainer</xref> objects that represent the containers for the service client associated with this container.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.listContainersSegmented(final String)
id: listContainersSegmented(final String)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: listContainersSegmented(final String prefix)
nameWithType: CloudBlobContainer.listContainersSegmented(final String prefix)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.listContainersSegmented(final String prefix)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.listContainersSegmented*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1557
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns a result segment of an enumerable collection of containers whose names begin with the specified prefix for the service client associated with this container.</p>
<p></p>
syntax:
content: public ResultSegment<CloudBlobContainer> listContainersSegmented(final String prefix)
parameters:
- id: prefix
type: 3d93591e
description: <p>A <code>String</code> that represents the blob name prefix.</p>
return:
type: com.microsoft.azure.storage._result_segment78504a52com.microsoft.azure.storage.blob._cloud_blob_containera08ddfce
description: <p>A <xref uid="com.microsoft.azure.storage._result_segment" data-throw-if-not-resolved="false">ResultSegment</xref> object that contains a segment of the enumerable collection of <xref uid="com.microsoft.azure.storage.blob._cloud_blob_container" data-throw-if-not-resolved="false">CloudBlobContainer</xref> objects that represent the containers whose names begin with the specified prefix for the service client associated with this container.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.listContainersSegmented(final String,final ContainerListingDetails,final Integer,final ResultContinuation,final BlobRequestOptions,final OperationContext)
id: listContainersSegmented(final String,final ContainerListingDetails,final Integer,final ResultContinuation,final BlobRequestOptions,final OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: listContainersSegmented(final String prefix, final ContainerListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final BlobRequestOptions options, final OperationContext opContext)
nameWithType: CloudBlobContainer.listContainersSegmented(final String prefix, final ContainerListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final BlobRequestOptions options, final OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.listContainersSegmented(final String prefix, final ContainerListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final BlobRequestOptions options, final OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.listContainersSegmented*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1594
package: com.microsoft.azure.storage.blob
summary: >-
<p>Returns a result segment containing a collection of containers whose names begin with the specified prefix for the service client associated with this container, using the specified listing details options, request options, and operation context.</p>
<p></p>
syntax:
content: public ResultSegment<CloudBlobContainer> listContainersSegmented(final String prefix, final ContainerListingDetails detailsIncluded, final Integer maxResults, final ResultContinuation continuationToken, final BlobRequestOptions options, final OperationContext opContext)
parameters:
- id: prefix
type: 3d93591e
description: <p>A <code>String</code> that represents the prefix of the container name. </p>
- id: detailsIncluded
type: 93de0ef9com.microsoft.azure.storage.blob._container_listing_details
description: <p>A <xref uid="com.microsoft.azure.storage.blob._container_listing_details" data-throw-if-not-resolved="false">ContainerListingDetails</xref> object that indicates whether metadata is included. </p>
- id: maxResults
type: 3437983f
description: <p>The maximum number of results to retrieve. If <code>null</code> or greater than 5000, the server will return up to 5,000 items. Must be at least 1. </p>
- id: continuationToken
type: 93de0ef9com.microsoft.azure.storage._result_continuation
description: <p>A <xref uid="com.microsoft.azure.storage._result_continuation" data-throw-if-not-resolved="false">ResultContinuation</xref> object that represents a continuation token returned by a previous listing operation. </p>
- id: options
type: 93de0ef9com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client ( <xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>). </p>
- id: opContext
type: 93de0ef9com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.</p>
return:
type: com.microsoft.azure.storage._result_segment78504a52com.microsoft.azure.storage.blob._cloud_blob_containera08ddfce
description: <p>A <xref uid="com.microsoft.azure.storage._result_segment" data-throw-if-not-resolved="false">ResultSegment</xref> object that contains a segment of the enumerable collection of <xref uid="com.microsoft.azure.storage.blob._cloud_blob_container" data-throw-if-not-resolved="false">CloudBlobContainer</xref> objects that represent the containers whose names begin with the specified prefix for the service client associated with this container.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.metadata
id: metadata
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: metadata
nameWithType: CloudBlobContainer.metadata
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.metadata
type: Field
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 61
package: com.microsoft.azure.storage.blob
summary: <p>Represents the container metadata. </p>
syntax:
content: protected HashMap<String, String> metadata= new HashMap<String, String>()
return:
type: 3970a053
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.releaseLease(final AccessCondition)
id: releaseLease(final AccessCondition)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: releaseLease(final AccessCondition accessCondition)
nameWithType: CloudBlobContainer.releaseLease(final AccessCondition accessCondition)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.releaseLease(final AccessCondition accessCondition)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.releaseLease*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 2098
package: com.microsoft.azure.storage.blob
summary: >-
<p>Releases the lease on the container.</p>
<p></p>
syntax:
content: public final void releaseLease(final AccessCondition accessCondition)
parameters:
- id: accessCondition
type: 93de0ef9com.microsoft.azure.storage._access_condition
description: <p>An <xref uid="com.microsoft.azure.storage._access_condition" data-throw-if-not-resolved="false">AccessCondition</xref> object that represents the access conditions for the blob. The lease ID is required to be set with an access condition.</p>
return:
type: 3f6357ce
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.releaseLease(final AccessCondition,BlobRequestOptions,OperationContext)
id: releaseLease(final AccessCondition,BlobRequestOptions,OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: releaseLease(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
nameWithType: CloudBlobContainer.releaseLease(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.releaseLease(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.releaseLease*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 2124
package: com.microsoft.azure.storage.blob
summary: >-
<p>Releases the lease on the container using the specified access conditions, request options, and operation context.</p>
<p></p>
syntax:
content: public final void releaseLease(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
parameters:
- id: accessCondition
type: 93de0ef9com.microsoft.azure.storage._access_condition
description: <p>An <xref uid="com.microsoft.azure.storage._access_condition" data-throw-if-not-resolved="false">AccessCondition</xref> object that represents the access conditions for the blob. The lease ID is required to be set with an access condition.</p>
- id: options
type: com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client (<xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>).</p>
- id: opContext
type: com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. The context is used to track requests to the storage service, and to provide additional runtime information about the operation.</p>
return:
type: 3f6357ce
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.renewLease(final AccessCondition)
id: renewLease(final AccessCondition)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: renewLease(final AccessCondition accessCondition)
nameWithType: CloudBlobContainer.renewLease(final AccessCondition accessCondition)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.renewLease(final AccessCondition accessCondition)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.renewLease*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 2011
package: com.microsoft.azure.storage.blob
summary: >-
<p>Renews an existing lease with the specified access conditions.</p>
<p></p>
syntax:
content: public final void renewLease(final AccessCondition accessCondition)
parameters:
- id: accessCondition
type: 93de0ef9com.microsoft.azure.storage._access_condition
description: <p>An <xref uid="com.microsoft.azure.storage._access_condition" data-throw-if-not-resolved="false">AccessCondition</xref> object that represents the access conditions for the container. The lease ID is required to be set with an access condition.</p>
return:
type: 3f6357ce
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.renewLease(final AccessCondition,BlobRequestOptions,OperationContext)
id: renewLease(final AccessCondition,BlobRequestOptions,OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: renewLease(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
nameWithType: CloudBlobContainer.renewLease(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.renewLease(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.renewLease*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 2036
package: com.microsoft.azure.storage.blob
summary: >-
<p>Renews an existing lease with the specified access conditions, request options, and operation context.</p>
<p></p>
syntax:
content: public final void renewLease(final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
parameters:
- id: accessCondition
type: 93de0ef9com.microsoft.azure.storage._access_condition
description: <p>An <xref uid="com.microsoft.azure.storage._access_condition" data-throw-if-not-resolved="false">AccessCondition</xref> object that represents the access conditions for the blob. The lease ID is required to be set with an access condition.</p>
- id: options
type: com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client (<xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>).</p>
- id: opContext
type: com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. The context is used to track requests to the storage service, and to provide additional runtime information about the operation.</p>
return:
type: 3f6357ce
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.setMetadata(final HashMap<String, String>)
id: setMetadata(final HashMap<String, String>)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: setMetadata(final HashMap<String, String> metadata)
nameWithType: CloudBlobContainer.setMetadata(final HashMap<String, String> metadata)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.setMetadata(final HashMap<String, String> metadata)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.setMetadata*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1661
package: com.microsoft.azure.storage.blob
summary: >-
<p>Sets the metadata collection of name-value pairs to be set on the container with an <xref uid="com.microsoft.azure.storage.blob._cloud_blob_container.uploadMetadata()" data-throw-if-not-resolved="false">uploadMetadata</xref> call. This collection will overwrite any existing container metadata. If this is set to an empty collection, the container metadata will be cleared on an <xref uid="com.microsoft.azure.storage.blob._cloud_blob_container.uploadMetadata()" data-throw-if-not-resolved="false">uploadMetadata</xref> call.</p>
<p></p>
syntax:
content: public void setMetadata(final HashMap<String, String> metadata)
parameters:
- id: metadata
type: 496ce5ae
description: <p>A <code>java.util.HashMap</code> object that represents the metadata being assigned to the container. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.setProperties(final BlobContainerProperties)
id: setProperties(final BlobContainerProperties)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: setProperties(final BlobContainerProperties properties)
nameWithType: CloudBlobContainer.setProperties(final BlobContainerProperties properties)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.setProperties(final BlobContainerProperties properties)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.setProperties*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1682
package: com.microsoft.azure.storage.blob
summary: >-
<p>Sets the properties for the container.</p>
<p></p>
syntax:
content: protected void setProperties(final BlobContainerProperties properties)
parameters:
- id: properties
type: 93de0ef9com.microsoft.azure.storage.blob._blob_container_properties
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_container_properties" data-throw-if-not-resolved="false">BlobContainerProperties</xref> object that represents the properties being assigned to the container. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.setStorageUri(final StorageUri)
id: setStorageUri(final StorageUri)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: setStorageUri(final StorageUri storageUri)
nameWithType: CloudBlobContainer.setStorageUri(final StorageUri storageUri)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.setStorageUri(final StorageUri storageUri)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.setStorageUri*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1671
package: com.microsoft.azure.storage.blob
summary: >-
<p>Sets the list of URIs for all locations.</p>
<p></p>
syntax:
content: protected void setStorageUri(final StorageUri storageUri)
parameters:
- id: storageUri
type: 93de0ef9com.microsoft.azure.storage._storage_uri
description: <p>A <xref uid="com.microsoft.azure.storage._storage_uri" data-throw-if-not-resolved="false">StorageUri</xref> object which represents the list of URIs for all locations. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.uploadMetadata()
id: uploadMetadata()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: uploadMetadata()
nameWithType: CloudBlobContainer.uploadMetadata()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.uploadMetadata()
overload: com.microsoft.azure.storage.blob._cloud_blob_container.uploadMetadata*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1693
package: com.microsoft.azure.storage.blob
summary: >-
<p>Uploads the container's metadata.</p>
<p></p>
syntax: &o2
content: public void uploadMetadata()
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.uploadMetadata(AccessCondition,BlobRequestOptions,OperationContext)
id: uploadMetadata(AccessCondition,BlobRequestOptions,OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: uploadMetadata(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
nameWithType: CloudBlobContainer.uploadMetadata(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.uploadMetadata(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.uploadMetadata*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1715
package: com.microsoft.azure.storage.blob
summary: >-
<p>Uploads the container's metadata using the specified request options and operation context.</p>
<p></p>
syntax:
content: public void uploadMetadata(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
parameters:
- id: accessCondition
type: com.microsoft.azure.storage._access_condition
description: <p>An <xref uid="com.microsoft.azure.storage._access_condition" data-throw-if-not-resolved="false">AccessCondition</xref> object that represents the access conditions for the container. </p>
- id: options
type: com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client ( <xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>). </p>
- id: opContext
type: com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.uploadPermissions(final BlobContainerPermissions)
id: uploadPermissions(final BlobContainerPermissions)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: uploadPermissions(final BlobContainerPermissions permissions)
nameWithType: CloudBlobContainer.uploadPermissions(final BlobContainerPermissions permissions)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.uploadPermissions(final BlobContainerPermissions permissions)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.uploadPermissions*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1779
package: com.microsoft.azure.storage.blob
summary: >-
<p>Uploads the container's permissions.</p>
<p></p>
syntax:
content: public void uploadPermissions(final BlobContainerPermissions permissions)
parameters:
- id: permissions
type: 93de0ef9com.microsoft.azure.storage.blob._blob_container_permissions
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_container_permissions" data-throw-if-not-resolved="false">BlobContainerPermissions</xref> object that represents the permissions to upload.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.uploadPermissions(final BlobContainerPermissions,final AccessCondition,BlobRequestOptions,OperationContext)
id: uploadPermissions(final BlobContainerPermissions,final AccessCondition,BlobRequestOptions,OperationContext)
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
langs:
- java
name: uploadPermissions(final BlobContainerPermissions permissions, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
nameWithType: CloudBlobContainer.uploadPermissions(final BlobContainerPermissions permissions, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.uploadPermissions(final BlobContainerPermissions permissions, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
overload: com.microsoft.azure.storage.blob._cloud_blob_container.uploadPermissions*
type: Method
source:
remote: *o0
path: microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudBlobContainer.java
startLine: 1803
package: com.microsoft.azure.storage.blob
summary: >-
<p>Uploads the container's permissions using the specified request options and operation context.</p>
<p></p>
syntax:
content: public void uploadPermissions(final BlobContainerPermissions permissions, final AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)
parameters:
- id: permissions
type: 93de0ef9com.microsoft.azure.storage.blob._blob_container_permissions
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_container_permissions" data-throw-if-not-resolved="false">BlobContainerPermissions</xref> object that represents the permissions to upload. </p>
- id: accessCondition
type: 93de0ef9com.microsoft.azure.storage._access_condition
description: <p>An <xref uid="com.microsoft.azure.storage._access_condition" data-throw-if-not-resolved="false">AccessCondition</xref> object that represents the access conditions for the container. </p>
- id: options
type: com.microsoft.azure.storage.blob._blob_request_options
description: <p>A <xref uid="com.microsoft.azure.storage.blob._blob_request_options" data-throw-if-not-resolved="false">BlobRequestOptions</xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client ( <xref uid="com.microsoft.azure.storage.blob._cloud_blob_client" data-throw-if-not-resolved="false">CloudBlobClient</xref>). </p>
- id: opContext
type: com.microsoft.azure.storage._operation_context
description: <p>An <xref uid="com.microsoft.azure.storage._operation_context" data-throw-if-not-resolved="false">OperationContext</xref> object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.</p>
exceptions:
- type: ca4f407a
description: <p>If a storage service error occurred. </p>
references:
- uid: 3970a053
spec.java:
- name: HashMap<String, String>
fullName: HashMap<String, String>
- uid: ca4f407a
spec.java:
- name: StorageException
fullName: StorageException
- uid: bac42120
spec.java:
- name: final URI
fullName: final URI
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.CloudBlobContainer*
name: CloudBlobContainer
nameWithType: CloudBlobContainer.CloudBlobContainer
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.CloudBlobContainer
package: com.microsoft.azure.storage.blob
- uid: 93de0ef9com.microsoft.azure.storage._storage_uri
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.storage._storage_uri
name: StorageUri
fullName: com.microsoft.azure.storage.StorageUri
href: com.microsoft.azure.storage._storage_uri.yml
- uid: 93de0ef9com.microsoft.azure.storage._storage_credentials
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.storage._storage_credentials
name: StorageCredentials
fullName: com.microsoft.azure.storage.StorageCredentials
href: com.microsoft.azure.storage._storage_credentials.yml
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.create*
name: create
nameWithType: CloudBlobContainer.create
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.create
package: com.microsoft.azure.storage.blob
- uid: 4fc6e284
spec.java:
- name: boolean
fullName: boolean
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.createIfNotExists*
name: createIfNotExists
nameWithType: CloudBlobContainer.createIfNotExists
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.createIfNotExists
package: com.microsoft.azure.storage.blob
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.delete*
name: delete
nameWithType: CloudBlobContainer.delete
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.delete
package: com.microsoft.azure.storage.blob
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.deleteIfExists*
name: deleteIfExists
nameWithType: CloudBlobContainer.deleteIfExists
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.deleteIfExists
package: com.microsoft.azure.storage.blob
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.downloadAttributes*
name: downloadAttributes
nameWithType: CloudBlobContainer.downloadAttributes
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.downloadAttributes
package: com.microsoft.azure.storage.blob
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.downloadPermissions*
name: downloadPermissions
nameWithType: CloudBlobContainer.downloadPermissions
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.downloadPermissions
package: com.microsoft.azure.storage.blob
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.exists*
name: exists
nameWithType: CloudBlobContainer.exists
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.exists
package: com.microsoft.azure.storage.blob
- uid: 93de0ef9com.microsoft.azure.storage._access_condition
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.storage._access_condition
name: AccessCondition
fullName: com.microsoft.azure.storage.AccessCondition
href: com.microsoft.azure.storage._access_condition.yml
- uid: e333ca4f
spec.java:
- name: InvalidKeyException
fullName: InvalidKeyException
- uid: 93de0ef9com.microsoft.azure.storage.blob._shared_access_blob_policy
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.storage.blob._shared_access_blob_policy
name: SharedAccessBlobPolicy
fullName: com.microsoft.azure.storage.blob.SharedAccessBlobPolicy
href: com.microsoft.azure.storage.blob._shared_access_blob_policy.yml
- uid: 3d93591e
spec.java:
- name: final String
fullName: final String
- uid: "26831127"
spec.java:
- name: String
fullName: String
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.generateSharedAccessSignature*
name: generateSharedAccessSignature
nameWithType: CloudBlobContainer.generateSharedAccessSignature
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.generateSharedAccessSignature
package: com.microsoft.azure.storage.blob
- uid: 93de0ef9com.microsoft.azure.storage._i_p_range
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.storage._i_p_range
name: IPRange
fullName: com.microsoft.azure.storage.IPRange
href: com.microsoft.azure.storage._i_p_range.yml
- uid: 93de0ef9com.microsoft.azure.storage._shared_access_protocols
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.storage._shared_access_protocols
name: SharedAccessProtocols
fullName: com.microsoft.azure.storage.SharedAccessProtocols
href: com.microsoft.azure.storage._shared_access_protocols.yml
- uid: "44102508"
spec.java:
- name: URISyntaxException
fullName: URISyntaxException
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getAppendBlobReference*
name: getAppendBlobReference
nameWithType: CloudBlobContainer.getAppendBlobReference
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getAppendBlobReference
package: com.microsoft.azure.storage.blob
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getBlockBlobReference*
name: getBlockBlobReference
nameWithType: CloudBlobContainer.getBlockBlobReference
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getBlockBlobReference
package: com.microsoft.azure.storage.blob
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getDirectoryReference*
name: getDirectoryReference
nameWithType: CloudBlobContainer.getDirectoryReference
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getDirectoryReference
package: com.microsoft.azure.storage.blob
- uid: 93de0ef9com.microsoft.azure.storage.blob._cloud_blob
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.storage.blob._cloud_blob
name: CloudBlob
fullName: com.microsoft.azure.storage.blob.CloudBlob
href: com.microsoft.azure.storage.blob._cloud_blob.yml
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getBlobReferenceFromServer*
name: getBlobReferenceFromServer
nameWithType: CloudBlobContainer.getBlobReferenceFromServer
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getBlobReferenceFromServer
package: com.microsoft.azure.storage.blob
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getMetadata*
name: getMetadata
nameWithType: CloudBlobContainer.getMetadata
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getMetadata
package: com.microsoft.azure.storage.blob
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getName*
name: getName
nameWithType: CloudBlobContainer.getName
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getName
package: com.microsoft.azure.storage.blob
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getStorageUri*
name: getStorageUri
nameWithType: CloudBlobContainer.getStorageUri
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getStorageUri
package: com.microsoft.azure.storage.blob
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getPageBlobReference*
name: getPageBlobReference
nameWithType: CloudBlobContainer.getPageBlobReference
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getPageBlobReference
package: com.microsoft.azure.storage.blob
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getProperties*
name: getProperties
nameWithType: CloudBlobContainer.getProperties
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getProperties
package: com.microsoft.azure.storage.blob
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getServiceClient*
name: getServiceClient
nameWithType: CloudBlobContainer.getServiceClient
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getServiceClient
package: com.microsoft.azure.storage.blob
- uid: "62304784"
spec.java:
- name: URI
fullName: URI
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.getUri*
name: getUri
nameWithType: CloudBlobContainer.getUri
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.getUri
package: com.microsoft.azure.storage.blob
- uid: 2a13b5a5com.microsoft.azure.storage.blob._list_blob_itema08ddfce
spec.java:
- name: Iterable<
fullName: Iterable<
- uid: com.microsoft.azure.storage.blob._list_blob_item
name: ListBlobItem
fullName: com.microsoft.azure.storage.blob.ListBlobItem
href: com.microsoft.azure.storage.blob._list_blob_item.yml
- name: '>'
fullName: '>'
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.listBlobs*
name: listBlobs
nameWithType: CloudBlobContainer.listBlobs
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.listBlobs
package: com.microsoft.azure.storage.blob
- uid: 4dda0764
spec.java:
- name: final boolean
fullName: final boolean
- uid: 7f216280com.microsoft.azure.storage.blob._blob_listing_detailsa08ddfce
spec.java:
- name: final EnumSet<
fullName: final EnumSet<
- uid: com.microsoft.azure.storage.blob._blob_listing_details
name: BlobListingDetails
fullName: com.microsoft.azure.storage.blob.BlobListingDetails
href: com.microsoft.azure.storage.blob._blob_listing_details.yml
- name: '>'
fullName: '>'
- uid: com.microsoft.azure.storage._result_segment78504a52com.microsoft.azure.storage.blob._list_blob_itema08ddfce
spec.java:
- uid: com.microsoft.azure.storage._result_segment
name: ResultSegment
fullName: com.microsoft.azure.storage.ResultSegment
href: com.microsoft.azure.storage._result_segment.yml
- name: <
fullName: <
- uid: com.microsoft.azure.storage.blob._list_blob_item
name: ListBlobItem
fullName: com.microsoft.azure.storage.blob.ListBlobItem
href: com.microsoft.azure.storage.blob._list_blob_item.yml
- name: '>'
fullName: '>'
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.listBlobsSegmented*
name: listBlobsSegmented
nameWithType: CloudBlobContainer.listBlobsSegmented
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.listBlobsSegmented
package: com.microsoft.azure.storage.blob
- uid: 3437983f
spec.java:
- name: final Integer
fullName: final Integer
- uid: 93de0ef9com.microsoft.azure.storage._result_continuation
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.storage._result_continuation
name: ResultContinuation
fullName: com.microsoft.azure.storage.ResultContinuation
href: com.microsoft.azure.storage._result_continuation.yml
- uid: 2a13b5a5com.microsoft.azure.storage.blob._cloud_blob_containera08ddfce
spec.java:
- name: Iterable<
fullName: Iterable<
- uid: com.microsoft.azure.storage.blob._cloud_blob_container
name: CloudBlobContainer
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
- name: '>'
fullName: '>'
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.listContainers*
name: listContainers
nameWithType: CloudBlobContainer.listContainers
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.listContainers
package: com.microsoft.azure.storage.blob
- uid: 93de0ef9com.microsoft.azure.storage.blob._container_listing_details
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.storage.blob._container_listing_details
name: ContainerListingDetails
fullName: com.microsoft.azure.storage.blob.ContainerListingDetails
href: com.microsoft.azure.storage.blob._container_listing_details.yml
- uid: 93de0ef9com.microsoft.azure.storage.blob._blob_request_options
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.storage.blob._blob_request_options
name: BlobRequestOptions
fullName: com.microsoft.azure.storage.blob.BlobRequestOptions
href: com.microsoft.azure.storage.blob._blob_request_options.yml
- uid: 93de0ef9com.microsoft.azure.storage._operation_context
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.storage._operation_context
name: OperationContext
fullName: com.microsoft.azure.storage.OperationContext
href: com.microsoft.azure.storage._operation_context.yml
- uid: com.microsoft.azure.storage._result_segment78504a52com.microsoft.azure.storage.blob._cloud_blob_containera08ddfce
spec.java:
- uid: com.microsoft.azure.storage._result_segment
name: ResultSegment
fullName: com.microsoft.azure.storage.ResultSegment
href: com.microsoft.azure.storage._result_segment.yml
- name: <
fullName: <
- uid: com.microsoft.azure.storage.blob._cloud_blob_container
name: CloudBlobContainer
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
- name: '>'
fullName: '>'
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.listContainersSegmented*
name: listContainersSegmented
nameWithType: CloudBlobContainer.listContainersSegmented
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.listContainersSegmented
package: com.microsoft.azure.storage.blob
- uid: 496ce5ae
spec.java:
- name: final HashMap<String, String>
fullName: final HashMap<String, String>
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.setMetadata*
name: setMetadata
nameWithType: CloudBlobContainer.setMetadata
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.setMetadata
package: com.microsoft.azure.storage.blob
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.uploadMetadata*
name: uploadMetadata
nameWithType: CloudBlobContainer.uploadMetadata
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.uploadMetadata
package: com.microsoft.azure.storage.blob
- uid: 93de0ef9com.microsoft.azure.storage.blob._blob_container_permissions
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.storage.blob._blob_container_permissions
name: BlobContainerPermissions
fullName: com.microsoft.azure.storage.blob.BlobContainerPermissions
href: com.microsoft.azure.storage.blob._blob_container_permissions.yml
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.uploadPermissions*
name: uploadPermissions
nameWithType: CloudBlobContainer.uploadPermissions
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.uploadPermissions
package: com.microsoft.azure.storage.blob
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.acquireLease*
name: acquireLease
nameWithType: CloudBlobContainer.acquireLease
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.acquireLease
package: com.microsoft.azure.storage.blob
- uid: 3f6357ce
spec.java:
- name: final void
fullName: final void
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.renewLease*
name: renewLease
nameWithType: CloudBlobContainer.renewLease
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.renewLease
package: com.microsoft.azure.storage.blob
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.releaseLease*
name: releaseLease
nameWithType: CloudBlobContainer.releaseLease
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.releaseLease
package: com.microsoft.azure.storage.blob
- uid: 4c60ae65
spec.java:
- name: final long
fullName: final long
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.breakLease*
name: breakLease
nameWithType: CloudBlobContainer.breakLease
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.breakLease
package: com.microsoft.azure.storage.blob
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.changeLease*
name: changeLease
nameWithType: CloudBlobContainer.changeLease
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.changeLease
package: com.microsoft.azure.storage.blob
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.downloadAccountInfo*
name: downloadAccountInfo
nameWithType: CloudBlobContainer.downloadAccountInfo
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.downloadAccountInfo
package: com.microsoft.azure.storage.blob
- uid: 93de0ef9com.microsoft.azure.storage.blob._cloud_blob_client
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.storage.blob._cloud_blob_client
name: CloudBlobClient
fullName: com.microsoft.azure.storage.blob.CloudBlobClient
href: com.microsoft.azure.storage.blob._cloud_blob_client.yml
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.setStorageUri*
name: setStorageUri
nameWithType: CloudBlobContainer.setStorageUri
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.setStorageUri
package: com.microsoft.azure.storage.blob
- uid: 93de0ef9com.microsoft.azure.storage.blob._blob_container_properties
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.storage.blob._blob_container_properties
name: BlobContainerProperties
fullName: com.microsoft.azure.storage.blob.BlobContainerProperties
href: com.microsoft.azure.storage.blob._blob_container_properties.yml
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.setProperties*
name: setProperties
nameWithType: CloudBlobContainer.setProperties
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.setProperties
package: com.microsoft.azure.storage.blob
- uid: 93de0ef9com.microsoft.azure.storage._request_options
spec.java:
- name: 'final '
fullName: 'final '
- uid: com.microsoft.azure.storage._request_options
name: RequestOptions
fullName: com.microsoft.azure.storage.RequestOptions
href: com.microsoft.azure.storage._request_options.yml
- uid: com.microsoft.azure.storage.core._storage_request78504a52com.microsoft.azure.storage._service_clientb33c76fccom.microsoft.azure.storage.blob._cloud_blob_containerb33c76fccom.microsoft.azure.storage._account_informationa08ddfce
spec.java:
- uid: com.microsoft.azure.storage.core._storage_request
name: StorageRequest
fullName: com.microsoft.azure.storage.core.StorageRequest
href: com.microsoft.azure.storage.core._storage_request.yml
- name: <
fullName: <
- uid: com.microsoft.azure.storage._service_client
name: ServiceClient
fullName: com.microsoft.azure.storage.ServiceClient
href: com.microsoft.azure.storage._service_client.yml
- name: ', '
fullName: ', '
- uid: com.microsoft.azure.storage.blob._cloud_blob_container
name: CloudBlobContainer
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
- name: ', '
fullName: ', '
- uid: com.microsoft.azure.storage._account_information
name: AccountInformation
fullName: com.microsoft.azure.storage.AccountInformation
href: com.microsoft.azure.storage._account_information.yml
- name: '>'
fullName: '>'
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.downloadAccountInformationImpl*
name: downloadAccountInformationImpl
nameWithType: CloudBlobContainer.downloadAccountInformationImpl
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.downloadAccountInformationImpl
package: com.microsoft.azure.storage.blob
- uid: com.microsoft.azure.storage.blob._blob_container_properties
parent: com.microsoft.azure.storage.blob
href: com.microsoft.azure.storage.blob._blob_container_properties.yml
name: BlobContainerProperties
nameWithType: BlobContainerProperties
fullName: com.microsoft.azure.storage.blob.BlobContainerProperties
type: Class
summary: <p>Represents the system properties for a container. </p>
syntax:
content: public class BlobContainerProperties
- uid: com.microsoft.azure.storage._storage_uri
parent: com.microsoft.azure.storage
href: com.microsoft.azure.storage._storage_uri.yml
name: StorageUri
nameWithType: StorageUri
fullName: com.microsoft.azure.storage.StorageUri
type: Class
summary: <p>Holds a list of URIs that represents the storage resource. </p>
syntax:
content: public class StorageUri
- uid: com.microsoft.azure.storage.blob._cloud_blob_client
parent: com.microsoft.azure.storage.blob
href: com.microsoft.azure.storage.blob._cloud_blob_client.yml
name: CloudBlobClient
nameWithType: CloudBlobClient
fullName: com.microsoft.azure.storage.blob.CloudBlobClient
type: Class
summary: >-
<p>Provides a client for accessing the Microsoft Azure Blob service. </p>
<p>This class provides a point of access to the Blob service. The service client encapsulates the base URI for the Blob service. If the service client will be used for authenticated access, it also encapsulates the credentials for accessing the storage account. </p>
syntax:
content: public class CloudBlobClient extends ServiceClient
- uid: com.microsoft.azure.storage.blob._blob_container_permissions
parent: com.microsoft.azure.storage.blob
href: com.microsoft.azure.storage.blob._blob_container_permissions.yml
name: BlobContainerPermissions
nameWithType: BlobContainerPermissions
fullName: com.microsoft.azure.storage.blob.BlobContainerPermissions
type: Class
summary: >-
<p>Represents the permissions for a container. </p>
<p>The container's permissions encompass two types of access settings for the container: <ul><li><p>The container's public access setting, represented by the <xref uid="" data-throw-if-not-resolved="false">publicAccess</xref> property. The public access setting indicates whether the container and its blobs can be read via an anonymous request. </p></li><li><p>The container's access policies, represented by the <xref uid="com.microsoft.azure.storage._permissions.getSharedAccessPolicies()" data-throw-if-not-resolved="false">getSharedAccessPolicies</xref> method. This setting references a collection of shared access policies for the container. A shared access policy may be used to control the start time, expiry time, and permissions for one or more shared access signatures. A shared access signature provides delegated access to the container's resources. </p></li></ul>
For more information on managing container permissions, see <a href="http://go.microsoft.com/fwlink/?LinkID=224643">Managing Access to Containers and Blobs</a>. </p>
syntax:
content: public class BlobContainerPermissions extends Permissions<SharedAccessBlobPolicy>
- uid: com.microsoft.azure.storage._storage_exception
parent: com.microsoft.azure.storage
href: com.microsoft.azure.storage._storage_exception.yml
name: StorageException
nameWithType: StorageException
fullName: com.microsoft.azure.storage.StorageException
type: Class
summary: <p>Represents an exception for the Microsoft Azure storage service. </p>
syntax:
content: public class StorageException
- uid: com.microsoft.azure.storage._storage_credentials
parent: com.microsoft.azure.storage
href: com.microsoft.azure.storage._storage_credentials.yml
name: StorageCredentials
nameWithType: StorageCredentials
fullName: com.microsoft.azure.storage.StorageCredentials
type: Class
summary: <p>Represents a set of credentials used to authenticate access to a Microsoft Azure storage account. This is the base class for the <xref uid="com.microsoft.azure.storage._storage_credentials_account_and_key" data-throw-if-not-resolved="false">StorageCredentialsAccountAndKey</xref>, <xref uid="com.microsoft.azure.storage._storage_credentials_token" data-throw-if-not-resolved="false">StorageCredentialsToken</xref>, and <xref uid="com.microsoft.azure.storage._storage_credentials_shared_access_signature" data-throw-if-not-resolved="false">StorageCredentialsSharedAccessSignature</xref> classes. </p>
syntax:
content: public class StorageCredentials
- uid: com.microsoft.azure.storage.blob._blob_request_options
parent: com.microsoft.azure.storage.blob
href: com.microsoft.azure.storage.blob._blob_request_options.yml
name: BlobRequestOptions
nameWithType: BlobRequestOptions
fullName: com.microsoft.azure.storage.blob.BlobRequestOptions
type: Class
summary: <p>Represents a set of options that may be specified on a request. </p>
syntax:
content: public class BlobRequestOptions extends RequestOptions
- uid: com.microsoft.azure.storage._operation_context
parent: com.microsoft.azure.storage
href: com.microsoft.azure.storage._operation_context.yml
name: OperationContext
nameWithType: OperationContext
fullName: com.microsoft.azure.storage.OperationContext
type: Class
summary: <p>Represents the current logical operation. A logical operation may have a one-to-many relationship with multiple individual physical requests. </p>
syntax:
content: public class OperationContext
- uid: com.microsoft.azure.storage.blob._blob_container_public_access_type
parent: com.microsoft.azure.storage.blob
href: com.microsoft.azure.storage.blob._blob_container_public_access_type.yml
name: BlobContainerPublicAccessType
nameWithType: BlobContainerPublicAccessType
fullName: com.microsoft.azure.storage.blob.BlobContainerPublicAccessType
type: Enum
summary: >-
<p>Specifies the level of public access that is allowed on the container. </p>
<p>The public access setting indicates whether the container and its blobs can be read via an anonymous request. </p>
<p>The <xref uid="com.microsoft.azure.storage.blob._blob_container_public_access_type" data-throw-if-not-resolved="false">BlobContainerPublicAccessType</xref> enumeration provides three levels of anonymous read access: <ul><li><p><xref uid="com.microsoft.azure.storage.blob._blob_container_public_access_type.OFF" data-throw-if-not-resolved="false">BlobContainerPublicAccessType#OFF</xref>, which prevents anonymous access. </p></li><li><p><xref uid="com.microsoft.azure.storage.blob._blob_container_public_access_type.BLOB" data-throw-if-not-resolved="false">BlobContainerPublicAccessType#BLOB</xref>, which permits anonymous read access to blob resources, but not to container metadata or to the list of blobs in the container. </p></li><li><p><xref uid="com.microsoft.azure.storage.blob._blob_container_public_access_type.CONTAINER" data-throw-if-not-resolved="false">BlobContainerPublicAccessType#CONTAINER</xref>, which permits anonymous read access to blob resources, container metadata, and the list of blobs in the container. </p></li></ul>
For more information on managing anonymous access to Blob service resources, see <a href="http://go.microsoft.com/fwlink/?LinkID=224644&amp;clcid=0x409">Setting Access Control for Containers</a>. </p>
syntax:
content: public enum BlobContainerPublicAccessType
- uid: com.microsoft.azure.storage._access_condition
parent: com.microsoft.azure.storage
href: com.microsoft.azure.storage._access_condition.yml
name: AccessCondition
nameWithType: AccessCondition
fullName: com.microsoft.azure.storage.AccessCondition
type: Class
summary: <p>Represents a set of access conditions to be used for operations against the storage services. </p>
syntax:
content: public class AccessCondition
- uid: com.microsoft.azure.storage.blob._shared_access_blob_policy
parent: com.microsoft.azure.storage.blob
href: com.microsoft.azure.storage.blob._shared_access_blob_policy.yml
name: SharedAccessBlobPolicy
nameWithType: SharedAccessBlobPolicy
fullName: com.microsoft.azure.storage.blob.SharedAccessBlobPolicy
type: Class
summary: <p>Represents a shared access policy, which specifies the start time, expiry time, and permissions for a shared access signature. </p>
syntax:
content: public class SharedAccessBlobPolicy
- uid: com.microsoft.azure.storage._i_p_range
parent: com.microsoft.azure.storage
href: com.microsoft.azure.storage._i_p_range.yml
name: IPRange
nameWithType: IPRange
fullName: com.microsoft.azure.storage.IPRange
type: Class
summary: <p>A continuous range of IP addresses. </p>
syntax:
content: public class IPRange
- uid: com.microsoft.azure.storage._shared_access_protocols
parent: com.microsoft.azure.storage
href: com.microsoft.azure.storage._shared_access_protocols.yml
name: SharedAccessProtocols
nameWithType: SharedAccessProtocols
fullName: com.microsoft.azure.storage.SharedAccessProtocols
type: Enum
summary: <p>Specifies the set of possible permissions for a shared access protocol. </p>
syntax:
content: public enum SharedAccessProtocols
- uid: com.microsoft.azure.storage.blob._cloud_append_blob
parent: com.microsoft.azure.storage.blob
href: com.microsoft.azure.storage.blob._cloud_append_blob.yml
name: CloudAppendBlob
nameWithType: CloudAppendBlob
fullName: com.microsoft.azure.storage.blob.CloudAppendBlob
type: Class
summary: <p>Represents a Microsoft Azure Append Blob. </p>
syntax:
content: public class CloudAppendBlob extends CloudBlob
- uid: com.microsoft.azure.storage.blob._cloud_block_blob
parent: com.microsoft.azure.storage.blob
href: com.microsoft.azure.storage.blob._cloud_block_blob.yml
name: CloudBlockBlob
nameWithType: CloudBlockBlob
fullName: com.microsoft.azure.storage.blob.CloudBlockBlob
type: Class
summary: <p>Represents a blob that is uploaded as a set of blocks. </p>
syntax:
content: public class CloudBlockBlob
- uid: com.microsoft.azure.storage.blob._cloud_blob_directory
parent: com.microsoft.azure.storage.blob
href: com.microsoft.azure.storage.blob._cloud_blob_directory.yml
name: CloudBlobDirectory
nameWithType: CloudBlobDirectory
fullName: com.microsoft.azure.storage.blob.CloudBlobDirectory
type: Class
summary: >-
<p>Represents a virtual directory of blobs, designated by a delimiter character. </p>
<p>Containers, which are encapsulated as <xref uid="com.microsoft.azure.storage.blob._cloud_blob_container" data-throw-if-not-resolved="false">CloudBlobContainer</xref> objects, hold directories, and directories hold block blobs and page blobs. Directories can also contain sub-directories. </p>
syntax:
content: public class CloudBlobDirectory
- uid: com.microsoft.azure.storage.blob._cloud_blob
parent: com.microsoft.azure.storage.blob
href: com.microsoft.azure.storage.blob._cloud_blob.yml
name: CloudBlob
nameWithType: CloudBlob
fullName: com.microsoft.azure.storage.blob.CloudBlob
type: Class
summary: <p>Represents a Microsoft Azure blob. This is the base class for the <xref uid="com.microsoft.azure.storage.blob._cloud_block_blob" data-throw-if-not-resolved="false">CloudBlockBlob</xref> and <xref uid="com.microsoft.azure.storage.blob._cloud_page_blob" data-throw-if-not-resolved="false">CloudPageBlob</xref> classes. </p>
syntax:
content: public class CloudBlob implements ListBlobItem
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.downloadAttributes()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
name: downloadAttributes()
nameWithType: CloudBlobContainer.downloadAttributes()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.downloadAttributes()
type: Method
summary: >-
<p>Downloads the container's attributes, which consist of metadata and properties.</p>
<p></p>
syntax: *o1
- uid: com.microsoft.azure.storage.blob._cloud_blob_container.uploadMetadata()
parent: com.microsoft.azure.storage.blob._cloud_blob_container
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
name: uploadMetadata()
nameWithType: CloudBlobContainer.uploadMetadata()
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer.uploadMetadata()
type: Method
summary: >-
<p>Uploads the container's metadata.</p>
<p></p>
syntax: *o2
- uid: com.microsoft.azure.storage.blob._cloud_page_blob
parent: com.microsoft.azure.storage.blob
href: com.microsoft.azure.storage.blob._cloud_page_blob.yml
name: CloudPageBlob
nameWithType: CloudPageBlob
fullName: com.microsoft.azure.storage.blob.CloudPageBlob
type: Class
summary: <p>Represents a Microsoft Azure page blob. </p>
syntax:
content: public class CloudPageBlob
- uid: com.microsoft.azure.storage.blob._list_blob_item
parent: com.microsoft.azure.storage.blob
href: com.microsoft.azure.storage.blob._list_blob_item.yml
name: ListBlobItem
nameWithType: ListBlobItem
fullName: com.microsoft.azure.storage.blob.ListBlobItem
type: Interface
summary: <p>Represents an item that may be returned by a blob listing operation. </p>
syntax:
content: public interface ListBlobItem
- uid: com.microsoft.azure.storage.blob._blob_listing_details
parent: com.microsoft.azure.storage.blob
href: com.microsoft.azure.storage.blob._blob_listing_details.yml
name: BlobListingDetails
nameWithType: BlobListingDetails
fullName: com.microsoft.azure.storage.blob.BlobListingDetails
type: Enum
summary: >-
<p>Specifies which items to include when listing a set of blobs. </p>
<p>By default, committed blocks are always returned. Use the values in this enum to include snapshots, metadata, and/or uncommitted blocks. </p>
syntax:
content: public enum BlobListingDetails
- uid: com.microsoft.azure.storage._result_segment
parent: com.microsoft.azure.storage
href: com.microsoft.azure.storage._result_segment.yml
name: ResultSegment<T>
nameWithType: ResultSegment<T>
fullName: com.microsoft.azure.storage.ResultSegment<T>
type: Class
summary: >-
<p>Represents a segment of results and contains continuation and pagination information.</p>
<p></p>
syntax:
content: public class ResultSegment<T>
typeParameters:
- id: T
type: 8ce1ecb9
description: <p>The type of the result that the segment contains. </p>
- uid: com.microsoft.azure.storage._result_continuation
parent: com.microsoft.azure.storage
href: com.microsoft.azure.storage._result_continuation.yml
name: ResultContinuation
nameWithType: ResultContinuation
fullName: com.microsoft.azure.storage.ResultContinuation
type: Class
summary: <p>Represents a continuation token for listing operations. Continuation tokens are used in methods that return a <xref uid="com.microsoft.azure.storage._result_segment" data-throw-if-not-resolved="false">ResultSegment</xref> object, such as <xref uid="com.microsoft.azure.storage.blob._cloud_blob_directory.listBlobsSegmented()" data-throw-if-not-resolved="false">CloudBlobDirectory#listBlobsSegmented</xref>. </p>
syntax:
content: public class ResultContinuation
- uid: com.microsoft.azure.storage.blob._cloud_blob_container
parent: com.microsoft.azure.storage.blob
href: com.microsoft.azure.storage.blob._cloud_blob_container.yml
name: CloudBlobContainer
nameWithType: CloudBlobContainer
fullName: com.microsoft.azure.storage.blob.CloudBlobContainer
type: Class
summary: >-
<p>Represents a container in the Microsoft Azure Blob service. </p>
<p>Containers hold directories, which are encapsulated as <xref uid="com.microsoft.azure.storage.blob._cloud_blob_directory" data-throw-if-not-resolved="false">CloudBlobDirectory</xref> objects, and directories hold block blobs and page blobs. Directories can also contain sub-directories. </p>
syntax: *o3
- uid: com.microsoft.azure.storage.blob._container_listing_details
parent: com.microsoft.azure.storage.blob
href: com.microsoft.azure.storage.blob._container_listing_details.yml
name: ContainerListingDetails
nameWithType: ContainerListingDetails
fullName: com.microsoft.azure.storage.blob.ContainerListingDetails
type: Enum
summary: <p>Specifies which details to include when listing the containers in this storage account. </p>
syntax:
content: public enum ContainerListingDetails
- uid: com.microsoft.azure.storage._account_information
parent: com.microsoft.azure.storage
href: com.microsoft.azure.storage._account_information.yml
name: AccountInformation
nameWithType: AccountInformation
fullName: com.microsoft.azure.storage.AccountInformation
type: Class
summary: <p>Holds information related to the storage account. </p>
syntax:
content: public class AccountInformation
- uid: com.microsoft.azure.storage.core._storage_request
parent: com.microsoft.azure.storage.core
href: com.microsoft.azure.storage.core._storage_request.yml
name: StorageRequest<C,P,R>
nameWithType: StorageRequest<C,P,R>
fullName: com.microsoft.azure.storage.core.StorageRequest<C,P,R>
type: Class
summary: >-
<p>RESERVED FOR INTERNAL USE. A class which encapsulate the execution of a given storage operation.</p>
<p></p>
syntax:
content: public class StorageRequest<C,P,R>
typeParameters:
- id: C
type: 37f8610d
description: <p>The service client type </p>
- id: P
type: db9ec244
description: <p>The type of the parent object, i.e. CloudBlobContainer for downloadAttributes etc. </p>
- id: R
type: d4d3e1e1
description: <p>The type of the expected result </p>
- uid: com.microsoft.azure.storage._service_client
parent: com.microsoft.azure.storage
href: com.microsoft.azure.storage._service_client.yml
name: ServiceClient
nameWithType: ServiceClient
fullName: com.microsoft.azure.storage.ServiceClient
type: Class
summary: <p>Provides a client for accessing the Microsoft Azure Storage service. </p>
syntax:
content: public class ServiceClient
- uid: com.microsoft.azure.storage._request_options
parent: com.microsoft.azure.storage
href: com.microsoft.azure.storage._request_options.yml
name: RequestOptions
nameWithType: RequestOptions
fullName: com.microsoft.azure.storage.RequestOptions
type: Class
summary: <p>Represents the options to use while processing a given request. </p>
syntax:
content: public class RequestOptions
- uid: com.microsoft.azure.storage.core._segmented_storage_request
parent: com.microsoft.azure.storage.core
href: com.microsoft.azure.storage.core._segmented_storage_request.yml
name: SegmentedStorageRequest
nameWithType: SegmentedStorageRequest
fullName: com.microsoft.azure.storage.core.SegmentedStorageRequest
type: Class
syntax:
content: public class SegmentedStorageRequest