com.microsoft.azure.storage.blob

Class ServiceURL

java.lang.Object

com.microsoft.azure.storage.blob.StorageURL

com.microsoft.azure.storage.blob.ServiceURL

public final class ServiceURL
extends StorageURL

Represents a URL to a blob service. This class does not hold any state about a particular storage account 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 and containers. Please see here for more information on containers.

Field Summary

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

storageClient

Constructor Summary

Constructors

Constructor and Description
ServiceURL(URL url, com.microsoft.rest.v2.http.HttpPipeline pipeline) Creates a ServiceURL object pointing to the account specified by the URL and using the provided pipeline to make HTTP requests.

Method Summary

Modifier and Type	Method and Description
ContainerURL	createContainerURL(String containerName) Creates a ContainerURL object pointing to the specified container.
io.reactivex.Single<ServiceGetAccountInfoResponse>	getAccountInfo() Returns the sku name and account kind for the account.
io.reactivex.Single<ServiceGetAccountInfoResponse>	getAccountInfo(com.microsoft.rest.v2.Context context) Returns the sku name and account kind for the account.
io.reactivex.Single<ServiceGetPropertiesResponse>	getProperties() Gets the properties of a storage account’s Blob service.
io.reactivex.Single<ServiceGetPropertiesResponse>	getProperties(com.microsoft.rest.v2.Context context) Gets the properties of a storage account’s Blob service.
io.reactivex.Single<ServiceGetStatisticsResponse>	getStatistics() Retrieves statistics related to replication for the Blob service.
io.reactivex.Single<ServiceGetStatisticsResponse>	getStatistics(com.microsoft.rest.v2.Context context) Retrieves statistics related to replication for the Blob service.
io.reactivex.Single<ServiceGetUserDelegationKeyResponse>	getUserDelegationKey(OffsetDateTime start, OffsetDateTime expiry) Gets a user delegation key for use with this account's blob storage.
io.reactivex.Single<ServiceGetUserDelegationKeyResponse>	getUserDelegationKey(OffsetDateTime start, OffsetDateTime expiry, com.microsoft.rest.v2.Context context) Gets a user delegation key for use with this account's blob storage.
io.reactivex.Single<ServiceListContainersSegmentResponse>	listContainersSegment(String marker, ListContainersOptions options) Returns a single segment of containers starting from the specified Marker.
io.reactivex.Single<ServiceListContainersSegmentResponse>	listContainersSegment(String marker, ListContainersOptions options, com.microsoft.rest.v2.Context context) Returns a single segment of containers starting from the specified Marker.
io.reactivex.Single<ServiceSetPropertiesResponse>	setProperties(StorageServiceProperties properties) Sets properties for a storage account's Blob service endpoint.
io.reactivex.Single<ServiceSetPropertiesResponse>	setProperties(StorageServiceProperties properties, com.microsoft.rest.v2.Context context) Sets properties for a storage account's Blob service endpoint.
ServiceURL	withPipeline(com.microsoft.rest.v2.http.HttpPipeline pipeline) Creates a new ServiceURL with the given pipeline.

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

appendToURLPath, createPipeline, createPipeline, createPipeline, createPipeline, toString, toURL

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceURL

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

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

Parameters:

url - A url to an Azure Storage account.

pipeline - A HttpPipeline which configures the behavior of HTTP exchanges. Please refer to StorageURL.createPipeline(ICredentials, PipelineOptions) for more information.

Method Detail

createContainerURL

public ContainerURL createContainerURL(String containerName)

Creates a ContainerURL object pointing to the specified container. This method does not create a container. It simply constructs the URL to the container and offers access to methods relevant to containers.

Parameters:

containerName - The name of the container to point to.

Returns:

A ContainerURL object pointing to the specified container

withPipeline

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

Creates a new ServiceURL with the given pipeline.

Parameters:

pipeline - An HttpPipeline object to set.

Returns:

A ServiceURL object with the given pipeline.

listContainersSegment

public io.reactivex.Single<ServiceListContainersSegmentResponse> listContainersSegment(String marker,
                                                                                       ListContainersOptions options)

Returns a single segment of containers starting from the specified Marker. Use an empty marker to start enumeration from the beginning. Container names are returned in lexicographic order. After getting a segment, process it, and then call ListContainers 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 ListContainersSegmentResponse.body().nextMarker(). Set to null to list the first segment.

options - A ListContainersOptions which specifies what data should be returned by the service.

Returns:

Emits the successful response.

listContainersSegment

public io.reactivex.Single<ServiceListContainersSegmentResponse> listContainersSegment(String marker,
                                                                                       ListContainersOptions options,
                                                                                       com.microsoft.rest.v2.Context context)

Returns a single segment of containers starting from the specified Marker. Use an empty marker to start enumeration from the beginning. Container names are returned in lexicographic order. After getting a segment, process it, and then call ListContainers 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 ListContainersSegmentResponse.body().nextMarker(). Set to null to list the first segment.

options - A ListContainersOptions which specifies what data should be returned by the service.

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.

getProperties

public io.reactivex.Single<ServiceGetPropertiesResponse> getProperties()

Gets the properties of a storage account’s Blob service. For more information, see the Azure Docs.

Returns:

Emits the successful response.

getProperties

public io.reactivex.Single<ServiceGetPropertiesResponse> getProperties(com.microsoft.rest.v2.Context context)

Gets the properties of a storage account’s Blob service. For more information, see the Azure Docs.

Parameters:

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.

setProperties

public io.reactivex.Single<ServiceSetPropertiesResponse> setProperties(StorageServiceProperties properties)

Sets properties for a storage account's Blob service endpoint. For more information, see the Azure Docs. Note that setting the default service version has no effect when using this client because this client explicitly sets the version header on each request, overriding the default.

Parameters:

properties - Configures the service.

Returns:

Emits the successful response.

setProperties

public io.reactivex.Single<ServiceSetPropertiesResponse> setProperties(StorageServiceProperties properties,
                                                                       com.microsoft.rest.v2.Context context)

Sets properties for a storage account's Blob service endpoint. For more information, see the Azure Docs. Note that setting the default service version has no effect when using this client because this client explicitly sets the version header on each request, overriding the default.

Parameters:

properties - Configures the service.

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.

getUserDelegationKey

public io.reactivex.Single<ServiceGetUserDelegationKeyResponse> getUserDelegationKey(OffsetDateTime start,
                                                                                     OffsetDateTime expiry)

Gets a user delegation key for use with this account's blob storage. Note: This method call is only valid when using TokenCredentials in this object's HttpPipeline.

Parameters:

start - Start time for the key's validity. Null indicates immediate start.

expiry - Expiration of the key's validity.

Returns:

Emits the successful response.

getUserDelegationKey

public io.reactivex.Single<ServiceGetUserDelegationKeyResponse> getUserDelegationKey(OffsetDateTime start,
                                                                                     OffsetDateTime expiry,
                                                                                     com.microsoft.rest.v2.Context context)

Gets a user delegation key for use with this account's blob storage. Note: This method call is only valid when using TokenCredentials in this object's HttpPipeline.

Parameters:

start - Start time for the key's validity. Null indicates immediate start.

expiry - Expiration of the key's validity.

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.

getStatistics

public io.reactivex.Single<ServiceGetStatisticsResponse> getStatistics()

Retrieves statistics related to replication for the Blob service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account. For more information, see the Azure Docs.

Returns:

Emits the successful response.

getStatistics

public io.reactivex.Single<ServiceGetStatisticsResponse> getStatistics(com.microsoft.rest.v2.Context context)

Retrieves statistics related to replication for the Blob service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account. For more information, see the Azure Docs.

Parameters:

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.

getAccountInfo

public io.reactivex.Single<ServiceGetAccountInfoResponse> getAccountInfo()

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

Returns:

Emits the successful response.

getAccountInfo

public io.reactivex.Single<ServiceGetAccountInfoResponse> getAccountInfo(com.microsoft.rest.v2.Context context)

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

Parameters:

context - Context offers a means of passing arbitrary data (key/value pairs) to an HttpPipeline's policy objects. Most applications do not need to pass arbitrary data to the pipeline and can pass Context.NONE or null. Each context object is immutable. The withContext with data method creates a new Context object that refers to its parent, forming a linked list.

Returns:

Emits the successful response.