ContainerURL Class

Definition

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.

public class ContainerURL extends StorageURL
Inheritance
java.lang.Object
ContainerURL

Inherited Members

Constructors

ContainerURL(URL url, HttpPipeline pipeline)

Creates aContainerURLĀ  object pointing to the account specified by the URL and using the provided pipeline to make HTTP requests.

Fields

LOG_CONTAINER_NAME
ROOT_CONTAINER_NAME
STATIC_WEBSITE_CONTAINER_NAME

Methods

acquireLease(String proposedId, int duration)

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.

acquireLease(String proposedID, int duration, ModifiedAccessConditions modifiedAccessConditions, Context context)

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.

breakLease()

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

breakLease(Integer breakPeriodInSeconds, ModifiedAccessConditions modifiedAccessConditions, Context context)

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

changeLease(String leaseID, String proposedID)

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

changeLease(String leaseID, String proposedID, ModifiedAccessConditions modifiedAccessConditions, Context context)

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

create()

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

create(Metadata metadata, PublicAccessType accessType, Context context)

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

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.

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.

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.

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.

delete()

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

delete(ContainerAccessConditions accessConditions, Context context)

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

getAccessPolicy()

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

getAccessPolicy(LeaseAccessConditions leaseAccessConditions, Context context)

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

getAccountInfo()

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

getAccountInfo(Context context)

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

getProperties()

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

getProperties(LeaseAccessConditions leaseAccessConditions, Context context)

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

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.

listBlobsFlatSegment(String marker, ListBlobsOptions options, Context context)

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.

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.

listBlobsHierarchySegment(String marker, String delimiter, ListBlobsOptions options, Context context)

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.

releaseLease(String leaseID)

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

releaseLease(String leaseID, ModifiedAccessConditions modifiedAccessConditions, Context context)

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

renewLease(String leaseID)

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

renewLease(String leaseID, ModifiedAccessConditions modifiedAccessConditions, Context context)

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

setAccessPolicy(PublicAccessType accessType, List<SignedIdentifier> identifiers)

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

setAccessPolicy(PublicAccessType accessType, List<SignedIdentifier> identifiers, ContainerAccessConditions accessConditions, Context context)

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

setMetadata(Metadata metadata)

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

setMetadata(Metadata metadata, ContainerAccessConditions accessConditions, Context context)

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

withPipeline(HttpPipeline pipeline)

Creates a new ContainerURL with the given pipeline.

Applies to