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 the Azure Storage container allowing you to manipulate its blobs.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerLeaseHeaders,java.lang.Void>>	acquireLease(java.lang.String proposedID, java.lang.Integer duration, HTTPAccessConditions httpAccessConditions) Acquires a lease on the container for delete operations.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerLeaseHeaders,java.lang.Void>>	breakLease(HTTPAccessConditions httpAccessConditions) Breaks the container's previously-acquired lease.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerCreateHeaders,java.lang.Void>>	create(Metadata metadata, PublicAccessType accessType) Creates a new container within a storage account.
AppendBlobURL	createAppendBlobURL(java.lang.String blobName) Creates creates a new AppendBlobURL object by concatenating blobName to the end of ContainerURL's URL.
BlobURL	createBlobURL(java.lang.String blobName) Creates a new BlobURL object by concatenating blobName to the end of ContainerURL's URL.
BlockBlobURL	createBlockBlobURL(java.lang.String blobName) Creates a new BlockBlobURL object by concatenating the blobName to the end of ContainerURL's URL.
PageBlobURL	createPageBlobURL(java.lang.String blobName) Creates creates a new PageBlobURL object by concatenating blobName to the end of ContainerURL's URL.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerDeleteHeaders,java.lang.Void>>	delete(ContainerAccessConditions accessConditions) Marks the specified container for deletion.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerGetAclHeaders,java.util.List<SignedIdentifier>>>	getPermissions(LeaseAccessConditions leaseAccessConditions) Returns the container's permissions.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerGetPropertiesHeaders,java.lang.Void>>	getPropertiesAndMetadata(LeaseAccessConditions leaseAccessConditions) Returns the container's metadata and system properties.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerListBlobsHeaders,ListBlobsResponse>>	listBlobs(java.lang.String marker, ListBlobsOptions options) Returns a single segment of blobs starting from the specified Marker.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerLeaseHeaders,java.lang.Void>>	releaseLease(java.lang.String leaseID, HTTPAccessConditions httpAccessConditions) Releases the container's previously-acquired lease.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerLeaseHeaders,java.lang.Void>>	releaseLease(java.lang.String leaseID, java.lang.String proposedID, HTTPAccessConditions httpAccessConditions) Changes the container's leaseID.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerLeaseHeaders,java.lang.Void>>	renewLease(java.lang.String leaseID, HTTPAccessConditions httpAccessConditions) Renews the container's previously-acquired lease.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerSetMetadataHeaders,java.lang.Void>>	setMetadata(Metadata metadata, ContainerAccessConditions accessConditions) Sets the container's metadata.
io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerSetAclHeaders,java.lang.Void>>	setPermissions(PublicAccessType accessType, java.util.List<SignedIdentifier> identifiers, ContainerAccessConditions accessConditions) Sets the container's permissions.
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

createPipeline, toString, toURL

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ContainerURL

public ContainerURL(java.net.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(java.lang.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(java.lang.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(java.lang.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(java.lang.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<com.microsoft.rest.v2.RestResponse<ContainerCreateHeaders,java.lang.Void>> 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 https://docs.microsoft.com/rest/api/storageservices/create-container.

Parameters:

metadata - A Metadata object that specifies key value pairs to set on the blob.

accessType - A value of the class PublicAccessType.

Returns:

The Single which emits a RestResponse containing the ContainerCreateHeaders an a Void body if successful.

delete

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerDeleteHeaders,java.lang.Void>> 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 https://docs.microsoft.com/rest/api/storageservices/delete-container.

Parameters:

accessConditions - A ContainerAccessConditions object that specifies under which conditions the operation should complete.

Returns:

The Single which emits a RestResponse containing the ContainerDeleteHeaders an a Void body if successful.

getPropertiesAndMetadata

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerGetPropertiesHeaders,java.lang.Void>> getPropertiesAndMetadata(LeaseAccessConditions leaseAccessConditions)

Returns the container's metadata and system properties. For more information, see https://docs.microsoft.com/rest/api/storageservices/get-container-metadata.

Parameters:

leaseAccessConditions - A LeaseAccessConditions object that specifies the lease on the container if there is one.

Returns:

The Single which emits a RestResponse containing the ContainerGetPropertiesHeaders an a Void body if successful.

setMetadata

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerSetMetadataHeaders,java.lang.Void>> setMetadata(Metadata metadata,
                                                                                                                       ContainerAccessConditions accessConditions)

Sets the container's metadata. For more information, see https://docs.microsoft.com/rest/api/storageservices/set-container-metadata.

Parameters:

metadata - A Metadata object that specifies key value pairs to set on the blob.

accessConditions - A ContainerAccessConditions object that specifies under which conditions the operation should complete.

Returns:

The Single which emits a RestResponse containing the ContainerSetMetadataHeaders and a Void body if successful.

getPermissions

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerGetAclHeaders,java.util.List<SignedIdentifier>>> getPermissions(LeaseAccessConditions leaseAccessConditions)

Returns the container's permissions. The permissions indicate whether container's blobs may be accessed publicly. For more information, see https://docs.microsoft.com/rest/api/storageservices/get-container-acl.

Parameters:

leaseAccessConditions - A LeaseAccessConditions object that specifies the lease on the container if there is one.

Returns:

The Single which emits a RestResponse containing the ContainerGetAclHeaders and a List of SignedIdentifier as the body if successful.

setPermissions

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerSetAclHeaders,java.lang.Void>> setPermissions(PublicAccessType accessType,
                                                                                                                     java.util.List<SignedIdentifier> identifiers,
                                                                                                                     ContainerAccessConditions accessConditions)

Sets the container's permissions. The permissions indicate whether blobs in a container may be accessed publicly. For more information, see https://docs.microsoft.com/rest/api/storageservices/set-container-acl.

Parameters:

accessType - A value of the class PublicAccessType. Passing null turns off public access.

identifiers - A java.util.List of SignedIdentifier objects that specify the permissions for the container.

accessConditions - A ContainerAccessConditions object that specifies under which conditions the operation should complete.

Returns:

The Single which emits a RestResponse containing the ContainerSetAclHeaders an a Void body if successful.

acquireLease

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerLeaseHeaders,java.lang.Void>> acquireLease(java.lang.String proposedID,
                                                                                                                  java.lang.Integer 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 https://docs.microsoft.com/rest/api/storageservices/lease-container.

Parameters:

proposedID - A String in any valid GUID format.

duration - A Integer specifies 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 - A HTTPAccessConditions object that represents HTTP access conditions.

Returns:

The Single which emits a RestResponse containing the ContainerLeaseHeaders an a Void body if successful.

renewLease

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerLeaseHeaders,java.lang.Void>> renewLease(java.lang.String leaseID,
                                                                                                                HTTPAccessConditions httpAccessConditions)

Renews the container's previously-acquired lease. For more information, see https://docs.microsoft.com/rest/api/storageservices/lease-container.

Parameters:

leaseID - A String representing the lease on the blob.

httpAccessConditions - A HTTPAccessConditions object that represents HTTP access conditions.

Returns:

The Single which emits a RestResponse containing the ContainerLeaseHeaders an a Void body if successful.

releaseLease

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerLeaseHeaders,java.lang.Void>> releaseLease(java.lang.String leaseID,
                                                                                                                  HTTPAccessConditions httpAccessConditions)

Releases the container's previously-acquired lease. For more information, see https://docs.microsoft.com/rest/api/storageservices/lease-container.

Parameters:

leaseID - A String representing the lease on the blob.

httpAccessConditions - A HTTPAccessConditions object that represents HTTP access conditions.

Returns:

The Single which emits a RestResponse containing the ContainerLeaseHeaders an a Void body if successful.

breakLease

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerLeaseHeaders,java.lang.Void>> breakLease(HTTPAccessConditions httpAccessConditions)

Breaks the container's previously-acquired lease. For more information, see https://docs.microsoft.com/rest/api/storageservices/lease-container.

Parameters:

httpAccessConditions - A HTTPAccessConditions object that represents HTTP access conditions.

Returns:

The Single which emits a RestResponse containing the ContainerLeaseHeaders an a Void body if successful.

releaseLease

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerLeaseHeaders,java.lang.Void>> releaseLease(java.lang.String leaseID,
                                                                                                                  java.lang.String proposedID,
                                                                                                                  HTTPAccessConditions httpAccessConditions)

Changes the container's leaseID. For more information, see https://docs.microsoft.com/rest/api/storageservices/lease-container.

Parameters:

leaseID - A String representing the lease on the blob.

proposedID - A String in any valid GUID format.

httpAccessConditions - A HTTPAccessConditions object that represents HTTP access conditions.

Returns:

The Single which emits a RestResponse containing the ContainerLeaseHeaders an a Void body if successful.

listBlobs

public io.reactivex.Single<com.microsoft.rest.v2.RestResponse<ContainerListBlobsHeaders,ListBlobsResponse>> listBlobs(java.lang.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 https://docs.microsoft.com/rest/api/storageservices/list-blobs.

Parameters:

marker - A String value that identifies the portion of the list to be returned with the next list operation.

options - A ListBlobsOptions object which specifies one or more datasets to include in the response.

Returns:

The Single which emits a RestResponse containing the ContainerListBlobsHeaders and a ListBlobsResponse as the body if successful.