CloudBlobContainer (Microsoft Windows Azure Client API 0.4.6 API)

java.lang.Object
- com.microsoft.windowsazure.services.blob.client.CloudBlobContainer

```
public final class CloudBlobContainer
extends Object
```
Represents a container in the Windows Azure Blob service.
Containers hold directories, which are encapsulated as CloudBlobDirectory objects, and directories hold block blobs and page blobs. Directories can also contain sub-directories.

Field Summary

Fields
Modifier and Type Field and Description

protected HashMap<String,String> metadata
Represents the container metadata.

Fields
Modifier and Type	Field and Description
`protected HashMap<String,String>`	`metadata` Represents the container metadata.

Constructor Summary

Constructors
Constructor and Description
`CloudBlobContainer(String containerAddress, CloudBlobClient client)` Creates an instance of the `CloudBlobContainer` class using the specified address and client.
`CloudBlobContainer(URI uri, CloudBlobClient client)` Creates an instance of the `CloudBlobContainer` class using the specified URI and client.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`acquireLease(Integer leaseTimeInSeconds, String proposedLeaseId)` Acquires a new lease on the container with the specified lease time and proposed lease ID.
`String`	`acquireLease(Integer leaseTimeInSeconds, String proposedLeaseId, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)` Acquires a new lease on the container with the specified lease time, proposed lease ID, request options, and operation context.
`long`	`breakLease(Integer breakPeriodInSeconds)` Breaks the lease and ensures that another client cannot acquire a new lease until the current lease period has expired.
`long`	`breakLease(Integer breakPeriodInSeconds, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)` 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.
`void`	`changeLease(String proposedLeaseId, AccessCondition accessCondition)` Changes the existing lease ID to the proposed lease ID.
`void`	`changeLease(String proposedLeaseId, AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)` Changes the existing lease ID to the proposed lease Id with the specified access conditions, request options, and operation context.
`void`	`create()` Creates the container.
`void`	`create(BlobRequestOptions options, OperationContext opContext)` Creates the container using the specified options and operation context.
`boolean`	`createIfNotExist()` Creates the container if it does not exist.
`boolean`	`createIfNotExist(BlobRequestOptions options, OperationContext opContext)` Creates the container if it does not exist, using the specified request options and operation context.
`void`	`delete()` Deletes the container.
`void`	`delete(BlobRequestOptions options, OperationContext opContext)` Deletes the container using the specified request options and operation context.
`boolean`	`deleteIfExists()` Deletes the container if it exists.
`boolean`	`deleteIfExists(BlobRequestOptions options, OperationContext opContext)` Deletes the container if it exists using the specified request options and operation context.
`void`	`downloadAttributes()` Downloads the container's attributes, which consist of metadata and properties.
`void`	`downloadAttributes(BlobRequestOptions options, OperationContext opContext)` Downloads the container's attributes, which consist of metadata and properties, using the specified request options and operation context.
`BlobContainerPermissions`	`downloadPermissions()` Downloads the permission settings for the container.
`BlobContainerPermissions`	`downloadPermissions(BlobRequestOptions options, OperationContext opContext)` Downloads the permissions settings for the container using the specified request options and operation context.
`boolean`	`exists()` Returns a value that indicates whether the container exists.
`boolean`	`exists(BlobRequestOptions options, OperationContext opContext)` Returns a value that indicates whether the container exists, using the specified request options and operation context.
`String`	`generateSharedAccessSignature(SharedAccessBlobPolicy policy, String groupPolicyIdentifier)` Returns a shared access signature for the container.
`CloudBlockBlob`	`getBlockBlobReference(String blobAddressUri)` Returns a reference to a `CloudBlockBlob` object that represents a block blob in this container.
`CloudBlockBlob`	`getBlockBlobReference(String blobAddressUri, String snapshotID)` Returns a reference to a `CloudBlockBlob` object that represents a block blob in this container, using the specified snapshot ID.
`CloudBlobDirectory`	`getDirectoryReference(String relativeAddress)` Returns a reference to a `CloudBlobDirectory` object that represents a virtual blob directory within this container.
`HashMap<String,String>`	`getMetadata()` Returns the metadata for the container.
`String`	`getName()` Returns the name of the container.
`CloudPageBlob`	`getPageBlobReference(String blobAddressUri)` Returns a reference to a `CloudPageBlob` object that represents a page blob in this container.
`CloudPageBlob`	`getPageBlobReference(String blobAddressUri, String snapshotID)` Returns a reference to a `CloudPageBlob` object that represents a page blob in the directory, using the specified snapshot ID.
`BlobContainerProperties`	`getProperties()` Returns the properties for the container.
`CloudBlobClient`	`getServiceClient()` Returns the Blob service client associated with this container.
`protected URI`	`getTransformedAddress()` Returns the URI after applying the authentication transformation.
`URI`	`getUri()` Returns the URI for this container.
`Iterable<ListBlobItem>`	`listBlobs()` Returns an enumerable collection of blob items for the container.
`Iterable<ListBlobItem>`	`listBlobs(String prefix)` Returns an enumerable collection of blob items for the container whose names begin with the specified prefix.
`Iterable<ListBlobItem>`	`listBlobs(String prefix, boolean useFlatBlobListing, EnumSet<BlobListingDetails> listingDetails, BlobRequestOptions options, OperationContext opContext)` Returns an enumerable 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.
`ResultSegment<ListBlobItem>`	`listBlobsSegmented()` Returns a result segment of an enumerable collection of blob items in the container.
`ResultSegment<ListBlobItem>`	`listBlobsSegmented(String prefix)` Returns a result segment containing a collection of blob items whose names begin with the specified prefix.
`ResultSegment<ListBlobItem>`	`listBlobsSegmented(String prefix, boolean useFlatBlobListing, EnumSet<BlobListingDetails> listingDetails, int maxResults, ResultContinuation continuationToken, BlobRequestOptions options, OperationContext opContext)` 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.
`Iterable<CloudBlobContainer>`	`listContainers()` Returns an enumerable collection of containers for the service client associated with this container.
`Iterable<CloudBlobContainer>`	`listContainers(String prefix)` Returns an enumerable collection of containers whose names begin with the specified prefix for the service client associated with this container.
`Iterable<CloudBlobContainer>`	`listContainers(String prefix, ContainerListingDetails detailsIncluded, BlobRequestOptions options, OperationContext opContext)` 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.
`ResultSegment<CloudBlobContainer>`	`listContainersSegmented()` Returns a result segment of an enumerable collection of containers for the service client associated with this container.
`ResultSegment<CloudBlobContainer>`	`listContainersSegmented(String prefix)` 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.
`ResultSegment<CloudBlobContainer>`	`listContainersSegmented(String prefix, ContainerListingDetails detailsIncluded, int maxResults, ResultContinuation continuationToken, BlobRequestOptions options, OperationContext opContext)` 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.
`void`	`releaseLease(AccessCondition accessCondition)` Releases the lease on the container.
`void`	`releaseLease(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)` Releases the lease on the container using the specified access conditions, request options, and operation context.
`void`	`renewLease(AccessCondition accessCondition)` Renews an existing lease with the specified access conditions.
`void`	`renewLease(AccessCondition accessCondition, BlobRequestOptions options, OperationContext opContext)` Renews an existing lease with the specified access conditions, request options, and operation context.
`void`	`setMetadata(HashMap<String,String> metadata)` Sets the metadata for the container.
`protected void`	`setName(String name)` Sets the name of the container.
`protected void`	`setProperties(BlobContainerProperties properties)` Sets the properties for the container.
`protected void`	`setUri(URI uri)` Sets the URI of the container.
`void`	`uploadMetadata()` Uploads the container's metadata.
`void`	`uploadMetadata(BlobRequestOptions options, OperationContext opContext)` Uploads the container's metadata using the specified request options and operation context.
`void`	`uploadPermissions(BlobContainerPermissions permissions)` Uploads the container's permissions.
`void`	`uploadPermissions(BlobContainerPermissions permissions, BlobRequestOptions options, OperationContext opContext)` Uploads the container's permissions using the specified request options and operation context.

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

- Field Detail
  - metadata
```
protected HashMap<String,String> metadata
```
    Represents the container metadata.
- Constructor Detail
  - CloudBlobContainer
```
public CloudBlobContainer(String containerAddress,
                  CloudBlobClient client)
                   throws URISyntaxException,
                          StorageException
```
    Creates an instance of the CloudBlobContainer class using the specified address and client.
    
    Parameters:
    containerAddress - A String that represents either the absolute URI to the container, or the container name.
    client - A CloudBlobClient object that represents the associated service client, and that specifies the endpoint for the Blob service.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException - If the resource URI is invalid.
  - CloudBlobContainer
```
public CloudBlobContainer(URI uri,
                  CloudBlobClient client)
                   throws URISyntaxException,
                          StorageException
```
    Creates an instance of the CloudBlobContainer class using the specified URI and client.
    
    Parameters:
    uri - A java.net.URI object that represents the URI of the container.
    client - A CloudBlobClient object that represents the associated service client, and that specifies the endpoint for the Blob service.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException - If the resource URI is invalid.
- Method Detail
  - create
```
@DoesServiceRequest
public void create()
            throws StorageException
```
    Creates the container.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - create
```
@DoesServiceRequest
public void create(BlobRequestOptions options,
                             OperationContext opContext)
            throws StorageException
```
    Creates the container using the specified options and operation context.
    
    Parameters:
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).
    opContext - An OperationContext 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.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - createIfNotExist
```
@DoesServiceRequest
public boolean createIfNotExist()
                         throws StorageException
```
    Creates the container if it does not exist.
    
    Returns:
    true if the container did not already exist and was created; otherwise, false.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - createIfNotExist
```
@DoesServiceRequest
public boolean createIfNotExist(BlobRequestOptions options,
                                          OperationContext opContext)
                         throws StorageException
```
    Creates the container if it does not exist, using the specified request options and operation context.
    
    Parameters:
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).
    opContext - An OperationContext 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.
    
    Returns:
    true if the container did not already exist and was created; otherwise, false.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - delete
```
@DoesServiceRequest
public void delete()
            throws StorageException
```
    Deletes the container.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - delete
```
@DoesServiceRequest
public void delete(BlobRequestOptions options,
                             OperationContext opContext)
            throws StorageException
```
    Deletes the container using the specified request options and operation context.
    
    Parameters:
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).
    opContext - An OperationContext 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.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - deleteIfExists
```
@DoesServiceRequest
public boolean deleteIfExists()
                       throws StorageException
```
    Deletes the container if it exists.
    
    Returns:
    true if the container did not already exist and was created; otherwise, false.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - deleteIfExists
```
@DoesServiceRequest
public boolean deleteIfExists(BlobRequestOptions options,
                                        OperationContext opContext)
                       throws StorageException
```
    Deletes the container if it exists using the specified request options and operation context.
    
    Parameters:
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).
    opContext - An OperationContext 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.
    
    Returns:
    true if the container did not already exist and was created; otherwise, false.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - downloadAttributes
```
@DoesServiceRequest
public void downloadAttributes()
                        throws StorageException
```
    Downloads the container's attributes, which consist of metadata and properties.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - downloadAttributes
```
@DoesServiceRequest
public void downloadAttributes(BlobRequestOptions options,
                                         OperationContext opContext)
                        throws StorageException
```
    Downloads the container's attributes, which consist of metadata and properties, using the specified request options and operation context.
    
    Parameters:
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).
    opContext - An OperationContext 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.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - downloadPermissions
```
@DoesServiceRequest
public BlobContainerPermissions downloadPermissions()
                                             throws StorageException
```
    Downloads the permission settings for the container.
    
    Returns:
    A BlobContainerPermissions object that represents the container's permissions.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - downloadPermissions
```
@DoesServiceRequest
public BlobContainerPermissions downloadPermissions(BlobRequestOptions options,
                                                              OperationContext opContext)
                                             throws StorageException
```
    Downloads the permissions settings for the container using the specified request options and operation context.
    
    Parameters:
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).
    opContext - An OperationContext 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.
    
    Returns:
    A BlobContainerPermissions object that represents the container's permissions.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - exists
```
@DoesServiceRequest
public boolean exists()
               throws StorageException
```
    Returns a value that indicates whether the container exists.
    
    Returns:
    true if the container exists, otherwise false.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - exists
```
@DoesServiceRequest
public boolean exists(BlobRequestOptions options,
                                OperationContext opContext)
               throws StorageException
```
    Returns a value that indicates whether the container exists, using the specified request options and operation context.
    
    Parameters:
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).
    opContext - An OperationContext 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.
    
    Returns:
    true if the container exists, otherwise false.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - generateSharedAccessSignature
```
public String generateSharedAccessSignature(SharedAccessBlobPolicy policy,
                                   String groupPolicyIdentifier)
                                     throws InvalidKeyException,
                                            StorageException
```
    Returns a shared access signature for the container. Note this does not contain the leading "?".
    
    Parameters:
    policy - The access policy for the shared access signature.
    groupPolicyIdentifier - A container-level access policy.
    
    Returns:
    a shared access signature for the container.
    
    Throws:
    
    InvalidKeyException
    
    StorageException
    
    IllegalArgumentException
  - getBlockBlobReference
```
public CloudBlockBlob getBlockBlobReference(String blobAddressUri)
                                     throws URISyntaxException,
                                            StorageException
```
    Returns a reference to a CloudBlockBlob object that represents a block blob in this container.
    
    Parameters:
    blobAddressUri - A String that represents the name of the blob, or the absolute URI to the blob.
    
    Returns:
    A CloudBlockBlob object that represents a reference to the specified block blob.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException - If the resource URI is invalid.
  - getBlockBlobReference
```
public CloudBlockBlob getBlockBlobReference(String blobAddressUri,
                                   String snapshotID)
                                     throws URISyntaxException,
                                            StorageException
```
    Returns a reference to a CloudBlockBlob object that represents a block blob in this container, using the specified snapshot ID.
    
    Parameters:
    blobAddressUri - A String that represents the name of the blob, or the absolute URI to the blob.
    snapshotID - A String that represents the snapshot ID of the blob.
    
    Returns:
    A CloudBlockBlob object that represents a reference to the specified block blob.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException - If the resource URI is invalid.
  - getDirectoryReference
```
public CloudBlobDirectory getDirectoryReference(String relativeAddress)
                                         throws URISyntaxException,
                                                StorageException
```
    Returns a reference to a CloudBlobDirectory object that represents a virtual blob directory within this container.
    
    Parameters:
    relativeAddress - A String that represents the name of the virtual blob directory, or the absolute URI to the virtual blob directory.
    
    Returns:
    A CloudBlobDirectory that represents a virtual blob directory within this container.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException - If the resource URI is invalid.
  - getMetadata
```
public HashMap<String,String> getMetadata()
```
    Returns the metadata for the container.
    
    Returns:
    A java.util.HashMap object that represents the metadata for the container.
  - getName
```
public String getName()
```
    Returns the name of the container.
    
    Returns:
    A String that represents the name of the container.
  - getPageBlobReference
```
public CloudPageBlob getPageBlobReference(String blobAddressUri)
                                   throws URISyntaxException,
                                          StorageException
```
    Returns a reference to a CloudPageBlob object that represents a page blob in this container.
    
    Parameters:
    blobAddressUri - A String that represents the name of the blob, or the absolute URI to the blob.
    
    Returns:
    A CloudPageBlob object that represents a reference to the specified page blob.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException - If the resource URI is invalid.
  - getPageBlobReference
```
public CloudPageBlob getPageBlobReference(String blobAddressUri,
                                 String snapshotID)
                                   throws URISyntaxException,
                                          StorageException
```
    Returns a reference to a CloudPageBlob object that represents a page blob in the directory, using the specified snapshot ID.
    
    Parameters:
    blobAddressUri - A String that represents the name of the blob, or the absolute URI to the blob.
    snapshotID - A String that represents the snapshot ID of the blob.
    
    Returns:
    A CloudPageBlob object that represents a reference to the specified page blob.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException - If the resource URI is invalid.
  - getProperties
```
public BlobContainerProperties getProperties()
```
    Returns the properties for the container.
    
    Returns:
    A BlobContainerProperties object that represents the properties for the container.
  - getServiceClient
```
public CloudBlobClient getServiceClient()
```
    Returns the Blob service client associated with this container.
    
    Returns:
    A CloudBlobClient object that represents the service client associated with this container.
  - getTransformedAddress
```
protected URI getTransformedAddress()
                             throws URISyntaxException,
                                    StorageException
```
    Returns the URI after applying the authentication transformation.
    
    Returns:
    A java.net.URI object that represents the URI after applying the authentication transformation.
    
    Throws:
    
    IllegalArgumentException - If an unexpected value is passed.
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException - If the resource URI is invalid.
  - getUri
```
public URI getUri()
```
    Returns the URI for this container.
    
    Returns:
    The absolute URI to the container.
  - listBlobs
```
@DoesServiceRequest
public Iterable<ListBlobItem> listBlobs()
```
    Returns an enumerable collection of blob items for the container.
    
    Returns:
    An enumerable collection of ListBlobItem objects that represents the items in this container.
  - listBlobs
```
@DoesServiceRequest
public Iterable<ListBlobItem> listBlobs(String prefix)
```
    Returns an enumerable collection of blob items for the container whose names begin with the specified prefix.
    
    Parameters:
    prefix - A String 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.
    
    Returns:
    An enumerable collection of ListBlobItem objects that represents the items whose names begin with the specified prefix in this container.
  - listBlobs
```
@DoesServiceRequest
public Iterable<ListBlobItem> listBlobs(String prefix,
                                                  boolean useFlatBlobListing,
                                                  EnumSet<BlobListingDetails> listingDetails,
                                                  BlobRequestOptions options,
                                                  OperationContext opContext)
```
    Returns an enumerable 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.
    
    Parameters:
    prefix - A String 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.
    useFlatBlobListing - true to indicate that the returned list will be flat; false to indicate that the returned list will be hierarchical.
    listingDetails - A java.util.EnumSet object that contains BlobListingDetails values that indicate whether snapshots, metadata, and/or uncommitted blocks are returned. Committed blocks are always returned.
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).
    opContext - An OperationContext 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.
    
    Returns:
    An enumerable collection of ListBlobItem objects that represent the block items whose names begin with the specified prefix in this directory.
    
    Throws:
    
    StorageException - If a storage service error occurred.
    
    URISyntaxException - If the resource URI is invalid.
  - listBlobsSegmented
```
@DoesServiceRequest
public ResultSegment<ListBlobItem> listBlobsSegmented()
                                               throws StorageException
```
    Returns a result segment of an enumerable collection of blob items in the container.
    
    Returns:
    A ResultSegment object that contains a segment of the enumerable collection of ListBlobItem objects that represent the blob items in the container.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - listBlobsSegmented
```
@DoesServiceRequest
public ResultSegment<ListBlobItem> listBlobsSegmented(String prefix)
                                               throws StorageException
```
    Returns a result segment containing a collection of blob items whose names begin with the specified prefix.
    
    Parameters:
    prefix - A String that represents the prefix of the blob name.
    
    Returns:
    A ResultSegment object that contains a segment of the enumerable collection of ListBlobItem objects that represent the blob items whose names begin with the specified prefix in the container.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - listBlobsSegmented
```
@DoesServiceRequest
public ResultSegment<ListBlobItem> listBlobsSegmented(String prefix,
                                                                boolean useFlatBlobListing,
                                                                EnumSet<BlobListingDetails> listingDetails,
                                                                int maxResults,
                                                                ResultContinuation continuationToken,
                                                                BlobRequestOptions options,
                                                                OperationContext opContext)
                                               throws StorageException
```
    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.
    
    Parameters:
    prefix - A String that represents the prefix of the blob name.
    useFlatBlobListing - true to indicate that the returned list will be flat; false to indicate that the returned list will be hierarchical.
    listingDetails - A java.util.EnumSet object that contains BlobListingDetails values that indicate whether snapshots, metadata, and/or uncommitted blocks are returned. Committed blocks are always returned.
    maxResults - The maximum number of results to retrieve.
    continuationToken - A ResultContinuation object that represents a continuation token returned by a previous listing operation.
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).
    opContext - An OperationContext 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.
    
    Returns:
    A ResultSegment object that contains a segment of the enumerable collection of ListBlobItem objects that represent the block items whose names begin with the specified prefix in the container.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - listContainers
```
@DoesServiceRequest
public Iterable<CloudBlobContainer> listContainers()
```
    Returns an enumerable collection of containers for the service client associated with this container.
    
    Returns:
    An enumerable collection of CloudBlobContainer objects that represent the containers for the service client associated with this container.
  - listContainers
```
@DoesServiceRequest
public Iterable<CloudBlobContainer> listContainers(String prefix)
```
    Returns an enumerable collection of containers whose names begin with the specified prefix for the service client associated with this container.
    
    Parameters:
    prefix - A String that represents the container name prefix.
    
    Returns:
    An enumerable collection of CloudBlobContainer objects that represent the containers whose names begin with the specified prefix for the service client associated with this container.
  - listContainers
```
@DoesServiceRequest
public Iterable<CloudBlobContainer> listContainers(String prefix,
                                                             ContainerListingDetails detailsIncluded,
                                                             BlobRequestOptions options,
                                                             OperationContext opContext)
```
    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.
    
    Parameters:
    prefix - A String that represents the container name prefix.
    detailsIncluded - A ContainerListingDetails value that indicates whether container metadata will be returned.
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).
    opContext - An OperationContext 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.
    
    Returns:
    An enumerable collection of CloudBlobContainer objects that represents the containers for the service client associated with this container.
  - listContainersSegmented
```
@DoesServiceRequest
public ResultSegment<CloudBlobContainer> listContainersSegmented()
                                                          throws StorageException
```
    Returns a result segment of an enumerable collection of containers for the service client associated with this container.
    
    Returns:
    A ResultSegment object that contains a segment of the enumerable collection of CloudBlobContainer objects that represent the containers for the service client associated with this container.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - listContainersSegmented
```
@DoesServiceRequest
public ResultSegment<CloudBlobContainer> listContainersSegmented(String prefix)
                                                          throws StorageException
```
    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.
    
    Parameters:
    prefix - A String that represents the blob name prefix.
    
    Returns:
    A ResultSegment object that contains a segment of the enumerable collection of CloudBlobContainer objects that represent the containers whose names begin with the specified prefix for the service client associated with this container.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - listContainersSegmented
```
@DoesServiceRequest
public ResultSegment<CloudBlobContainer> listContainersSegmented(String prefix,
                                                                           ContainerListingDetails detailsIncluded,
                                                                           int maxResults,
                                                                           ResultContinuation continuationToken,
                                                                           BlobRequestOptions options,
                                                                           OperationContext opContext)
                                                          throws StorageException
```
    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.
    
    Parameters:
    prefix - A String that represents the prefix of the container name.
    detailsIncluded - A ContainerListingDetails object that indicates whether metadata is included.
    maxResults - The maximum number of results to retrieve.
    continuationToken - A ResultContinuation object that represents a continuation token returned by a previous listing operation.
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).
    opContext - An OperationContext 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.
    
    Returns:
    A ResultSegment object that contains a segment of the enumerable collection of CloudBlobContainer objects that represent the containers whose names begin with the specified prefix for the service client associated with this container.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - setMetadata
```
public void setMetadata(HashMap<String,String> metadata)
```
    Sets the metadata for the container.
    
    Parameters:
    metadata - A java.util.HashMap object that represents the metadata being assigned to the container.
  - setName
```
protected void setName(String name)
```
    Sets the name of the container.
    
    Parameters:
    name - A String that represents the name being assigned to the container.
  - setProperties
```
protected void setProperties(BlobContainerProperties properties)
```
    Sets the properties for the container.
    
    Parameters:
    properties - A BlobContainerProperties object that represents the properties being assigned to the container.
  - setUri
```
protected void setUri(URI uri)
```
    Sets the URI of the container.
    
    Parameters:
    uri - A java.net.URI object that represents the URI being assigned to the container.
  - uploadMetadata
```
@DoesServiceRequest
public void uploadMetadata()
                    throws StorageException
```
    Uploads the container's metadata.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - uploadMetadata
```
@DoesServiceRequest
public void uploadMetadata(BlobRequestOptions options,
                                     OperationContext opContext)
                    throws StorageException
```
    Uploads the container's metadata using the specified request options and operation context.
    
    Parameters:
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).
    opContext - An OperationContext 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.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - uploadPermissions
```
@DoesServiceRequest
public void uploadPermissions(BlobContainerPermissions permissions)
                       throws StorageException
```
    Uploads the container's permissions.
    
    Parameters:
    permissions - A BlobContainerPermissions object that represents the permissions to upload.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - uploadPermissions
```
@DoesServiceRequest
public void uploadPermissions(BlobContainerPermissions permissions,
                                        BlobRequestOptions options,
                                        OperationContext opContext)
                       throws StorageException
```
    Uploads the container's permissions using the specified request options and operation context.
    
    Parameters:
    permissions - A BlobContainerPermissions object that represents the permissions to upload.
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudBlobClient).
    opContext - An OperationContext 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.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - acquireLease
```
@DoesServiceRequest
public final String acquireLease(Integer leaseTimeInSeconds,
                                     String proposedLeaseId)
                          throws StorageException
```
    Acquires a new lease on the container with the specified lease time and proposed lease ID.
    
    Parameters:
    leaseTimeInSeconds - 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.
    proposedLeaseId - A String that represents the proposed lease ID for the new lease, or null if no lease ID is proposed.
    
    Returns:
    A String that represents the lease ID.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - acquireLease
```
@DoesServiceRequest
public final String acquireLease(Integer leaseTimeInSeconds,
                                     String proposedLeaseId,
                                     AccessCondition accessCondition,
                                     BlobRequestOptions options,
                                     OperationContext opContext)
                          throws StorageException
```
    Acquires a new lease on the container with the specified lease time, proposed lease ID, request options, and operation context.
    
    Parameters:
    leaseTimeInSeconds - 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.
    proposedLeaseId - A String that represents the proposed lease ID for the new lease, or null if no lease ID is proposed.
    accessCondition - An AccessCondition object that represents the access conditions for the container.
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client (CloudBlobClient).
    opContext - An OperationContext 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.
    
    Returns:
    A String that represents the lease ID.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - renewLease
```
@DoesServiceRequest
public final void renewLease(AccessCondition accessCondition)
                      throws StorageException
```
    Renews an existing lease with the specified access conditions.
    
    Parameters:
    accessCondition - An AccessCondition object that represents the access conditions for the container. The lease ID is required to be set with an access condition.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - renewLease
```
@DoesServiceRequest
public final void renewLease(AccessCondition accessCondition,
                                 BlobRequestOptions options,
                                 OperationContext opContext)
                      throws StorageException
```
    Renews an existing lease with the specified access conditions, request options, and operation context.
    
    Parameters:
    accessCondition - An AccessCondition object that represents the access conditions for the blob. The lease ID is required to be set with an access condition.
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client (CloudBlobClient).
    opContext - An OperationContext 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.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - releaseLease
```
@DoesServiceRequest
public final void releaseLease(AccessCondition accessCondition)
                        throws StorageException
```
    Releases the lease on the container.
    
    Parameters:
    accessCondition - An AccessCondition object that represents the access conditions for the blob. The lease ID is required to be set with an access condition.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - releaseLease
```
@DoesServiceRequest
public final void releaseLease(AccessCondition accessCondition,
                                   BlobRequestOptions options,
                                   OperationContext opContext)
                        throws StorageException
```
    Releases the lease on the container using the specified access conditions, request options, and operation context.
    
    Parameters:
    accessCondition - An AccessCondition object that represents the access conditions for the blob. The lease ID is required to be set with an access condition.
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client (CloudBlobClient).
    opContext - An OperationContext 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.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - breakLease
```
@DoesServiceRequest
public final long breakLease(Integer breakPeriodInSeconds)
                      throws StorageException
```
    Breaks the lease and ensures that another client cannot acquire a new lease until the current lease period has expired.
    
    Parameters:
    breakPeriodInSeconds - 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.
    
    Returns:
    The time, in seconds, remaining in the lease period.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - breakLease
```
@DoesServiceRequest
public final long breakLease(Integer breakPeriodInSeconds,
                                 AccessCondition accessCondition,
                                 BlobRequestOptions options,
                                 OperationContext opContext)
                      throws StorageException
```
    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.
    
    Parameters:
    breakPeriodInSeconds - 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.
    accessCondition - An AccessCondition object that represents the access conditions for the blob.
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client (CloudBlobClient).
    opContext - An OperationContext 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.
    
    Returns:
    The time, in seconds, remaining in the lease period.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - changeLease
```
@DoesServiceRequest
public final void changeLease(String proposedLeaseId,
                                  AccessCondition accessCondition)
                       throws StorageException
```
    Changes the existing lease ID to the proposed lease ID.
    
    Parameters:
    proposedLeaseId - A String that represents the proposed lease ID for the new lease, or null if no lease ID is proposed.
    accessCondition - An AccessCondition object that represents the access conditions for the blob. The lease ID is required to be set with an access condition.
    
    Throws:
    
    StorageException - If a storage service error occurred.
  - changeLease
```
@DoesServiceRequest
public final void changeLease(String proposedLeaseId,
                                  AccessCondition accessCondition,
                                  BlobRequestOptions options,
                                  OperationContext opContext)
                       throws StorageException
```
    Changes the existing lease ID to the proposed lease Id with the specified access conditions, request options, and operation context.
    
    Parameters:
    proposedLeaseId - A String that represents the proposed lease ID for the new lease, or null if no lease ID is proposed.
    accessCondition - An AccessCondition object that represents the access conditions for the blob. The lease ID is required to be set with an access condition.
    options - A BlobRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client (CloudBlobClient).
    opContext - An OperationContext 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.
    
    Throws:
    
    StorageException - If a storage service error occurred.

/** 
* Copyright Microsoft Corporation 
* 
* Licensed under the Apache License, Version 2.0 (the "License"); 
* you may not use this file except in compliance with the License. 
* You may obtain a copy of the License at 
* http://www.apache.org/licenses/LICENSE-2.0 
* 
* Unless required by applicable law or agreed to in writing, software 
* distributed under the License is distributed on an "AS IS" BASIS, 
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
* See the License for the specific language governing permissions and 
* limitations under the License. 
*/

Class CloudBlobContainer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

metadata

Constructor Detail

CloudBlobContainer

CloudBlobContainer

Method Detail

create

create

createIfNotExist

createIfNotExist

delete

delete

deleteIfExists

deleteIfExists

downloadAttributes

downloadAttributes

downloadPermissions

downloadPermissions

exists

exists

generateSharedAccessSignature

getBlockBlobReference

getBlockBlobReference

getDirectoryReference

getMetadata

getName

getPageBlobReference

getPageBlobReference

getProperties

getServiceClient

getTransformedAddress

getUri

listBlobs

listBlobs

listBlobs

listBlobsSegmented

listBlobsSegmented

listBlobsSegmented

listContainers

listContainers

listContainers

listContainersSegmented

listContainersSegmented

listContainersSegmented

setMetadata

setName

setProperties

setUri

uploadMetadata

uploadMetadata

uploadPermissions

uploadPermissions

acquireLease

acquireLease

renewLease

renewLease

releaseLease

releaseLease

breakLease

breakLease

changeLease

changeLease