com.microsoft.azure.storage.blob

Class ContainerURL

java.lang.Object

com.microsoft.azure.storage.blob.StorageURL

com.microsoft.azure.storage.blob.ContainerURL

public final class ContainerURL
extends StorageURL

Represents a URL to a container. It may be obtained by direct construction or via the create method on a ServiceURL object. This class does not hold any state about a particular blob but is instead a convenient way of sending off appropriate requests to the resource on the service. It may also be used to construct URLs to blobs. Please refer to the Azure Docs for more information on containers.

Field Summary

Fields

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

Fields inherited from class com.microsoft.azure.storage.blob.StorageURL

storageClient

Constructor Summary

Constructors

Constructor and Description
ContainerURL(URL url, com.microsoft.rest.v2.http.HttpPipeline pipeline)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<ContainerAcquireLeaseResponse>	acquireLease(String proposedID, int duration, HTTPAccessConditions httpAccessConditions) Acquires a lease on the container for delete operations.
io.reactivex.Single<ContainerBreakLeaseResponse>	breakLease(Integer breakPeriodInSeconds, HTTPAccessConditions httpAccessConditions) Breaks the container's previously-acquired lease.
io.reactivex.Single<ContainerChangeLeaseResponse>	changeLease(String leaseID, String proposedID, HTTPAccessConditions httpAccessConditions) Changes the container's leaseID.
io.reactivex.Single<ContainerCreateResponse>	create(Metadata metadata, PublicAccessType accessType) Creates a new container within a storage account.
AppendBlobURL	createAppendBlobURL(String blobName) Creates creates a new AppendBlobURL object by concatenating blobName to the end of ContainerURL's URL.
BlobURL	createBlobURL(String blobName) Creates a new BlobURL object by concatenating blobName to the end of ContainerURL's URL.
BlockBlobURL	createBlockBlobURL(String blobName) Creates a new BlockBlobURL object by concatenating the blobName to the end of ContainerURL's URL.
PageBlobURL	createPageBlobURL(String blobName) Creates creates a new PageBlobURL object by concatenating blobName to the end of ContainerURL's URL.
io.reactivex.Single<ContainerDeleteResponse>	delete(ContainerAccessConditions accessConditions) Marks the specified container for deletion.
io.reactivex.Single<ContainerGetAccessPolicyResponse>	getAccessPolicy(LeaseAccessConditions leaseAccessConditions) Returns the container's permissions.
io.reactivex.Single<ContainerGetPropertiesResponse>	getProperties(LeaseAccessConditions leaseAccessConditions) Returns the container's metadata and system properties.
io.reactivex.Single<ContainerListBlobFlatSegmentResponse>	listBlobsFlatSegment(String marker, ListBlobsOptions options) Returns a single segment of blobs starting from the specified Marker.
io.reactivex.Single<ContainerListBlobHierarchySegmentResponse>	listBlobsHierarchySegment(String marker, String delimiter, ListBlobsOptions options) Returns a single segment of blobs and blob prefixes starting from the specified Marker.
io.reactivex.Single<ContainerReleaseLeaseResponse>	releaseLease(String leaseID, HTTPAccessConditions httpAccessConditions) Releases the container's previously-acquired lease.
io.reactivex.Single<ContainerRenewLeaseResponse>	renewLease(String leaseID, HTTPAccessConditions httpAccessConditions) Renews the container's previously-acquired lease.
io.reactivex.Single<ContainerSetAccessPolicyResponse>	setAccessPolicy(PublicAccessType accessType, List<SignedIdentifier> identifiers, ContainerAccessConditions accessConditions) Sets the container's permissions.
io.reactivex.Single<ContainerSetMetadataResponse>	setMetadata(Metadata metadata, ContainerAccessConditions accessConditions) Sets the container's metadata.
ContainerURL	withPipeline(com.microsoft.rest.v2.http.HttpPipeline pipeline) Creates a new ContainerURL with the given pipeline.

Methods inherited from class com.microsoft.azure.storage.blob.StorageURL

appendToURLPath, createPipeline, toString, toURL

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ROOT_CONTAINER_NAME

public static final String ROOT_CONTAINER_NAME

See Also:

Constant Field Values

STATIC_WEBSITE_CONTAINER_NAME

public static final String STATIC_WEBSITE_CONTAINER_NAME

See Also:

Constant Field Values

LOG_CONTAINER_NAME

public static final String LOG_CONTAINER_NAME

See Also:

Constant Field Values

Constructor Detail

ContainerURL

public ContainerURL(URL url,
                    com.microsoft.rest.v2.http.HttpPipeline pipeline)

Method Detail

withPipeline

public ContainerURL withPipeline(com.microsoft.rest.v2.http.HttpPipeline pipeline)

Creates a new ContainerURL with the given pipeline.

Parameters:

pipeline - An HttpPipeline object to set.

Returns:

A ContainerURL object with the given pipeline.

createBlockBlobURL

public BlockBlobURL createBlockBlobURL(String blobName)

Creates a new BlockBlobURL object by concatenating the blobName to the end of ContainerURL's URL. The new BlockBlobUrl uses the same request policy pipeline as the ContainerURL. To change the pipeline, create the BlockBlobUrl and then call its WithPipeline method passing in the desired pipeline object. Or, call this package's NewBlockBlobUrl instead of calling this object's NewBlockBlobUrl method.

Parameters:

blobName - A String representing the name of the blob.

Returns:

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

createPageBlobURL

public PageBlobURL createPageBlobURL(String blobName)

Creates creates a new PageBlobURL object by concatenating blobName to the end of ContainerURL's URL. The new PageBlobURL uses the same request policy pipeline as the ContainerURL. To change the pipeline, create the PageBlobURL and then call its WithPipeline method passing in the desired pipeline object. Or, call this package's NewPageBlobURL instead of calling this object's NewPageBlobURL method.

Parameters:

blobName - A String representing the name of the blob.

Returns:

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

createAppendBlobURL

public AppendBlobURL createAppendBlobURL(String blobName)

Creates creates a new AppendBlobURL object by concatenating blobName to the end of ContainerURL's URL. The new AppendBlobURL uses the same request policy pipeline as the ContainerURL. To change the pipeline, create the AppendBlobURL and then call its WithPipeline method passing in the desired pipeline object. Or, call this package's NewAppendBlobURL instead of calling this object's NewAppendBlobURL method.

Parameters:

blobName - A String representing the name of the blob.

Returns:

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

createBlobURL

public BlobURL createBlobURL(String blobName)

Creates a new BlobURL object by concatenating blobName to the end of ContainerURL's URL. The new BlobURL uses the same request policy pipeline as the ContainerURL. To change the pipeline, create the BlobURL and then call its WithPipeline method passing in the desired pipeline object. Or, call this package's createBlobURL instead of calling this object's createBlobURL method.

Parameters:

blobName - A String representing the name of the blob.

Returns:

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

create

public io.reactivex.Single<ContainerCreateResponse> create(Metadata metadata,
                                                           PublicAccessType accessType)

Creates a new container within a storage account. If a container with the same name already exists, the operation fails. For more information, see the Azure Docs.

Parameters:

metadata - Metadata

accessType - Specifies how the data in this container is available to the public. See the x-ms-blob-public-access header in the Azure Docs for more information. Pass null for no public access.

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=container_basic "Sample code for ContainerURL.create")] \n For more samples, please see the [Samples file](https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)

delete

public io.reactivex.Single<ContainerDeleteResponse> delete(ContainerAccessConditions accessConditions)

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

Parameters:

accessConditions - ContainerAccessConditions

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=container_basic "Sample code for ContainerURL.delete")] \n For more samples, please see the [Samples file](https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)

getProperties

public io.reactivex.Single<ContainerGetPropertiesResponse> getProperties(LeaseAccessConditions leaseAccessConditions)

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

Parameters:

leaseAccessConditions - LeaseAccessConditions

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=container_basic "Sample code for ContainerURL.getProperties")] \n For more samples, please see the [Samples file](https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)

setMetadata

public io.reactivex.Single<ContainerSetMetadataResponse> setMetadata(Metadata metadata,
                                                                     ContainerAccessConditions accessConditions)

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

Parameters:

metadata - Metadata

accessConditions - ContainerAccessConditions

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=container_basic "Sample code for ContainerURL.setMetadata")] \n For more samples, please see the [Samples file](https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)

getAccessPolicy

public io.reactivex.Single<ContainerGetAccessPolicyResponse> getAccessPolicy(LeaseAccessConditions leaseAccessConditions)

Returns the container's permissions. The permissions indicate whether container's blobs may be accessed publicly. For more information, see the Azure Docs.

Parameters:

leaseAccessConditions - LeaseAccessConditions

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=container_policy "Sample code for ContainerURL.getAccessPolicy")] \n For more samples, please see the [Samples file](https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)

setAccessPolicy

public io.reactivex.Single<ContainerSetAccessPolicyResponse> setAccessPolicy(PublicAccessType accessType,
                                                                             List<SignedIdentifier> identifiers,
                                                                             ContainerAccessConditions accessConditions)

Sets the container's permissions. The permissions indicate whether blobs in a container may be accessed publicly. Note that, for each signed identifier, we will truncate the start and expiry times to the nearest second to ensure the time formatting is compatible with the service. For more information, see the Azure Docs.

Parameters:

accessType - Specifies how the data in this container is available to the public. See the x-ms-blob-public-access header in the Azure Docs for more information. Pass null for no public access.

identifiers - A list of SignedIdentifier objects that specify the permissions for the container. Please see here for more information. Passing null will clear all access policies.

accessConditions - ContainerAccessConditions

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=container_policy "Sample code for ContainerURL.setAccessPolicy")] \n For more samples, please see the [Samples file](https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)

acquireLease

public io.reactivex.Single<ContainerAcquireLeaseResponse> acquireLease(String proposedID,
                                                                       int duration,
                                                                       HTTPAccessConditions httpAccessConditions)

Acquires a lease on the container for delete operations. The lease duration must be between 15 to 60 seconds, or infinite (-1). For more information, see the Azure Docs.

Parameters:

proposedID - A String in any valid GUID format.

duration - The duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds.

httpAccessConditions - HTTPAccessConditions

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=container_lease "Sample code for ContainerURL.acquireLease")] \n For more samples, please see the [Samples file](https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)

renewLease

public io.reactivex.Single<ContainerRenewLeaseResponse> renewLease(String leaseID,
                                                                   HTTPAccessConditions httpAccessConditions)

Renews the container's previously-acquired lease. For more information, see the Azure Docs.

Parameters:

leaseID - The leaseId of the active lease on the container.

httpAccessConditions - HTTPAccessConditions

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=container_lease "Sample code for ContainerURL.renewLease")] \n For more samples, please see the [Samples file](https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)

releaseLease

public io.reactivex.Single<ContainerReleaseLeaseResponse> releaseLease(String leaseID,
                                                                       HTTPAccessConditions httpAccessConditions)

Releases the container's previously-acquired lease. For more information, see the Azure Docs.

Parameters:

leaseID - The leaseId of the active lease on the container.

httpAccessConditions - HTTPAccessConditions

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=container_lease "Sample code for ContainerURL.releaseLease")] \n For more samples, please see the [Samples file](https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)

breakLease

public io.reactivex.Single<ContainerBreakLeaseResponse> breakLease(Integer breakPeriodInSeconds,
                                                                   HTTPAccessConditions httpAccessConditions)

Breaks the container's previously-acquired lease. For more information, see the Azure Docs.

Parameters:

breakPeriodInSeconds - An optional Integer representing the proposed duration of seconds that the lease should continue before it is broken, between 0 and 60 seconds. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period.

httpAccessConditions - HTTPAccessConditions

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=container_lease "Sample code for ContainerURL.breakLease")] \n For more samples, please see the [Samples file](https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)

changeLease

public io.reactivex.Single<ContainerChangeLeaseResponse> changeLease(String leaseID,
                                                                     String proposedID,
                                                                     HTTPAccessConditions httpAccessConditions)

Changes the container's leaseID. For more information, see the Azure Docs.

Parameters:

leaseID - The leaseId of the active lease on the container.

proposedID - A String in any valid GUID format.

httpAccessConditions - HTTPAccessConditions

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=container_lease "Sample code for ContainerURL.changeLease")] \n For more samples, please see the [Samples file](https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)

listBlobsFlatSegment

public io.reactivex.Single<ContainerListBlobFlatSegmentResponse> listBlobsFlatSegment(String marker,
                                                                                      ListBlobsOptions options)

Returns a single segment of blobs starting from the specified Marker. Use an empty marker to start enumeration from the beginning. Blob names are returned in lexicographic order. After getting a segment, process it, and then call ListBlobs again (passing the the previously-returned Marker) to get the next segment. For more information, see the Azure Docs.

Parameters:

marker - Identifies the portion of the list to be returned with the next list operation. This value is returned in the response of a previous list operation as the ListBlobsFlatSegmentResponse.body().nextMarker(). Set to null to list the first segment.

options - ListBlobsOptions

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=list_blobs_flat "Sample code for ContainerURL.listBlobsFlatSegment")] \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=list_blobs_flat_helper "helper code for ContainerURL.listBlobsFlatSegment")] \n For more samples, please see the [Samples file](https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)

listBlobsHierarchySegment

public io.reactivex.Single<ContainerListBlobHierarchySegmentResponse> listBlobsHierarchySegment(String marker,
                                                                                                String delimiter,
                                                                                                ListBlobsOptions options)

Returns a single segment of blobs and blob prefixes starting from the specified Marker. Use an empty marker to start enumeration from the beginning. Blob names are returned in lexicographic order. After getting a segment, process it, and then call ListBlobs again (passing the the previously-returned Marker) to get the next segment. For more information, see the Azure Docs.

Parameters:

marker - Identifies the portion of the list to be returned with the next list operation. This value is returned in the response of a previous list operation as the ListBlobsHierarchySegmentResponse.body().nextMarker(). Set to null to list the first segment.

delimiter - The operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string.

options - ListBlobsOptions

Returns:

Emits the successful response.

API Note:

## Sample Code \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=list_blobs_hierarchy "Sample code for ContainerURL.listBlobsHierarchySegment")] \n [!code-java[Sample_Code](../azure-storage-java/src/test/java/com/microsoft/azure/storage/Samples.java?name=list_blobs_hierarchy_helper "helper code for ContainerURL.listBlobsHierarchySegment")] \n For more samples, please see the [Samples file](https://github.com/Azure/azure-storage-java/blob/New-Storage-SDK-V10-Preview/src/test/java/com/microsoft/azure/storage/Samples.java)