com.azure.storage.blob.sas

Class BlobServiceSasQueryParameters

java.lang.Object

com.azure.storage.common.sas.BaseSasQueryParameters

com.azure.storage.blob.sas.BlobServiceSasQueryParameters

public final class BlobServiceSasQueryParameters
extends BaseSasQueryParameters

Represents the components that make up an Azure Storage SAS' query parameters. This type is not constructed directly by the user; it is only generated by the BlobServiceSasSignatureValues type. Once generated, it can be set on a BlobClientBuilder object to be constructed as part of a URL or it can be encoded into a String and appended to a URL directly (though caution should be taken here in case there are existing query parameters, which might affect the appropriate means of appending these query parameters). NOTE: Instances of this class are immutable to ensure thread safety.

Field Summary

Fields inherited from class com.azure.storage.common.sas.BaseSasQueryParameters

expiryTime, permissions, protocol, sasIpRange, signature, startTime, version

Constructor Summary

Constructors

Constructor and Description
BlobServiceSasQueryParameters(Map<String,String[]> queryParamsMap, boolean removeSASParametersFromMap) Creates a new BlobServiceSasQueryParameters object.

Method Summary

Modifier and Type	Method and Description
String	encode() Encodes all SAS query parameters into a string that can be appended to a URL.
String	getCacheControl()
String	getContentDisposition()
String	getContentEncoding()
String	getContentLanguage()
String	getContentType()
String	getIdentifier()
OffsetDateTime	getKeyExpiry()
String	getKeyObjectId()
String	getKeyService()
OffsetDateTime	getKeyStart()
String	getKeyTenantId()
String	getKeyVersion()
String	getResource()

Methods inherited from class com.azure.storage.common.sas.BaseSasQueryParameters

formatQueryParameterDate, getExpiryTime, getPermissions, getProtocol, getQueryParameter, getQueryParameter, getSasIpRange, getSignature, getStartTime, getVersion, tryAppendQueryParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

BlobServiceSasQueryParameters

public BlobServiceSasQueryParameters(Map<String,String[]> queryParamsMap,
                                     boolean removeSASParametersFromMap)

Creates a new BlobServiceSasQueryParameters object.

Parameters:

queryParamsMap - All query parameters for the request as key-value pairs

removeSASParametersFromMap - When true, the SAS query parameters will be removed from queryParamsMap

Method Detail

getIdentifier

public String getIdentifier()

Returns:

The signed identifier (only for BlobServiceSasSignatureValues) or null. Please see here for more information.

getResource

public String getResource()

Returns:

The storage container or blob (only for BlobServiceSasSignatureValues).

getCacheControl

public String getCacheControl()

Returns:

The Cache-Control header value when a client accesses the resource with this sas token.

getContentDisposition

public String getContentDisposition()

Returns:

The Content-Disposition header value when a client accesses the resource with this sas token.

getContentEncoding

public String getContentEncoding()

Returns:

The Content-Encoding header value when a client accesses the resource with this sas token.

getContentLanguage

public String getContentLanguage()

Returns:

The Content-Language header value when a client accesses the resource with this sas token.

getContentType

public String getContentType()

Returns:

The Content-Type header value when a client accesses the resource with this sas token.

getKeyObjectId

public String getKeyObjectId()

Returns:

the object ID of the key.

getKeyTenantId

public String getKeyTenantId()

Returns:

the tenant ID of the key.

getKeyStart

public OffsetDateTime getKeyStart()

Returns:

the datetime when the key becomes active.

getKeyExpiry

public OffsetDateTime getKeyExpiry()

Returns:

the datetime when the key expires.

getKeyService

public String getKeyService()

Returns:

the services that are permitted by the key.

getKeyVersion

public String getKeyVersion()

Returns:

the service version that created the key.

encode

public String encode()

Encodes all SAS query parameters into a string that can be appended to a URL.

Specified by:

encode in class BaseSasQueryParameters

Returns:

A String representing all SAS query parameters.