BlobServiceSasQueryParameters Class

Package:

com.azure.storage.blob.sas

Maven Artifact:

com.azure:azure-storage-blob:12.28.1

• java.lang.Object
• • com.azure.storage.common.sas.BaseSasQueryParameters
  • • com.azure.storage.blob.sas.BlobServiceSasQueryParameters

@Deprecated
public final class BlobServiceSasQueryParameters
extends BaseSasQueryParameters

Note

This class has been deprecated. Please use the generateSas method on the desired blob/container client after initializing BlobServiceSasSignatureValues.

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.

Constructor Summary

Constructor	Description
BlobServiceSasQueryParameters(Map<String,String[]> queryParamsMap, boolean removeSasParametersFromMap)	Deprecated Please use BlobServiceSasSignatureValues Creates a new BlobServiceSasQueryParameters object.

Method Summary

Modifier and Type	Method and Description
String	encode() Deprecated Please use the generateSas method on the desired blob/container client after initializing BlobServiceSasSignatureValues. Encodes all SAS query parameters into a string that can be appended to a URL.
String	getCacheControl() Deprecated Please use BlobServiceSasSignatureValues
String	getContentDisposition() Deprecated Please use BlobServiceSasSignatureValues
String	getContentEncoding() Deprecated Please use BlobServiceSasSignatureValues
String	getContentLanguage() Deprecated Please use BlobServiceSasSignatureValues
String	getContentType() Deprecated Please use BlobServiceSasSignatureValues
String	getIdentifier() Deprecated Please use BlobServiceSasSignatureValues
OffsetDateTime	getKeyExpiry() Deprecated Please use BlobServiceSasSignatureValues
String	getKeyObjectId() Deprecated Please use BlobServiceSasSignatureValues
String	getKeyService() Deprecated Please use BlobServiceSasSignatureValues
OffsetDateTime	getKeyStart() Deprecated Please use BlobServiceSasSignatureValues
String	getKeyTenantId() Deprecated Please use BlobServiceSasSignatureValues
String	getKeyVersion() Deprecated Please use BlobServiceSasSignatureValues
String	getResource() Deprecated Please use BlobServiceSasSignatureValues

Methods inherited from BaseSasQueryParameters

<T>getQueryParameter encode formatQueryParameterDate getExpiryTime getPermissions getProtocol getQueryParameter getSasIpRange getSignature getStartTime getVersion tryAppendQueryParameter

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BlobServiceSasQueryParameters

@Deprecated
public BlobServiceSasQueryParameters(Map queryParamsMap, boolean removeSasParametersFromMap)

Deprecated

Please use BlobServiceSasSignatureValues

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 Details

encode

@Deprecated
public String encode()

Deprecated

Please use the generateSas method on the desired blob/container client after initializing BlobServiceSasSignatureValues.

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

Overrides:

BlobServiceSasQueryParameters.encode()

Returns:

A String representing the SAS query parameters.

getCacheControl

@Deprecated
public String getCacheControl()

Deprecated

Please use BlobServiceSasSignatureValues

Returns:

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

getContentDisposition

@Deprecated
public String getContentDisposition()

Deprecated

Please use BlobServiceSasSignatureValues

Returns:

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

getContentEncoding

@Deprecated
public String getContentEncoding()

Deprecated

Please use BlobServiceSasSignatureValues

Returns:

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

getContentLanguage

@Deprecated
public String getContentLanguage()

Deprecated

Please use BlobServiceSasSignatureValues

Returns:

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

getContentType

@Deprecated
public String getContentType()

Deprecated

Please use BlobServiceSasSignatureValues

Returns:

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

getIdentifier

@Deprecated
public String getIdentifier()

Deprecated

Please use BlobServiceSasSignatureValues

Returns:

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

getKeyExpiry

@Deprecated
public OffsetDateTime getKeyExpiry()

Deprecated

Please use BlobServiceSasSignatureValues

Returns:

the datetime when the key expires.

getKeyObjectId

@Deprecated
public String getKeyObjectId()

Deprecated

Please use BlobServiceSasSignatureValues

Returns:

the object ID of the key.

getKeyService

@Deprecated
public String getKeyService()

Deprecated

Please use BlobServiceSasSignatureValues

Returns:

the services that are permitted by the key.

getKeyStart

@Deprecated
public OffsetDateTime getKeyStart()

Deprecated

Please use BlobServiceSasSignatureValues

Returns:

the datetime when the key becomes active.

getKeyTenantId

@Deprecated
public String getKeyTenantId()

Deprecated

Please use BlobServiceSasSignatureValues

Returns:

the tenant ID of the key.

getKeyVersion

@Deprecated
public String getKeyVersion()

Deprecated

Please use BlobServiceSasSignatureValues

Returns:

the service version that created the key.

getResource

@Deprecated
public String getResource()

Deprecated

Please use BlobServiceSasSignatureValues

Returns:

The storage container or blob (only for BlobServiceSasSignatureValues).