com.microsoft.azure.storage.blob

Class SASQueryParameters

java.lang.Object

com.microsoft.azure.storage.blob.SASQueryParameters

public final class SASQueryParameters
extends Object

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 AccountSASSignatureValues and ServiceSASSignatureValues types. Once generated, it can be set on a BlobURLParts 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.

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()
OffsetDateTime	getExpiryTime()
String	getIdentifier()
IPRange	getIpRange()
String	getPermissions()
SASProtocol	getProtocol()
String	getResource()
String	getResourceTypes()
String	getServices()
String	getSignature()
OffsetDateTime	getStartTime()
String	getVersion()

Methods inherited from class java.lang.Object

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

Method Detail

getVersion

public String getVersion()

Returns:

The storage version

getServices

public String getServices()

Returns:

The storage services being accessed (only for Account SAS). Please refer to AccountSASService for more details.

getResourceTypes

public String getResourceTypes()

Returns:

The storage resource types being accessed (only for Account SAS). Please refer to AccountSASResourceType for more details.

getProtocol

public SASProtocol getProtocol()

Returns:

The allowed HTTP protocol(s) or null. Please refer to SASProtocol for more details.

getStartTime

public OffsetDateTime getStartTime()

Returns:

The start time for this SAS token or null.

getExpiryTime

public OffsetDateTime getExpiryTime()

Returns:

The expiry time for this SAS token.

getIpRange

public IPRange getIpRange()

Returns:

IPRange

getIdentifier

public String getIdentifier()

Returns:

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

getResource

public String getResource()

Returns:

The storage container or blob (only for ServiceSASSignatureValues).

getPermissions

public String getPermissions()

Returns:

Please refer to AccountSASPermission, BlobSASPermission, or ContainerSASPermission for more details.

getSignature

public String getSignature()

Returns:

The signature for the SAS token.

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.

encode

public String encode()

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

Returns:

A String representing all SAS query parameters.