Share via

BlobServiceSasQueryParameters Class

  • Reference
Package:
com.azure.storage.blob.sas
Maven Artifact:
com.azure:azure-storage-blob:12.29.0

@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

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
String getContentDisposition()

Deprecated
String getContentEncoding()

Deprecated
String getContentLanguage()

Deprecated
String getContentType()

Deprecated
String getIdentifier()

Deprecated
OffsetDateTime getKeyExpiry()

Deprecated
String getKeyObjectId()

Deprecated
String getKeyService()

Deprecated
OffsetDateTime getKeyStart()

Deprecated
String getKeyTenantId()

Deprecated
String getKeyVersion()

Deprecated
String getResource()

Deprecated

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

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

Returns:

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

getContentDisposition

@Deprecated
public String getContentDisposition()

Deprecated

Returns:

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

getContentEncoding

@Deprecated
public String getContentEncoding()

Deprecated

Returns:

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

getContentLanguage

@Deprecated
public String getContentLanguage()

Deprecated

Returns:

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

getContentType

@Deprecated
public String getContentType()

Deprecated

Returns:

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

getIdentifier

@Deprecated
public String getIdentifier()

Deprecated

Returns:

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

getKeyExpiry

@Deprecated
public OffsetDateTime getKeyExpiry()

Deprecated

Returns:

the datetime when the key expires.

getKeyObjectId

@Deprecated
public String getKeyObjectId()

Deprecated

Returns:

the object ID of the key.

getKeyService

@Deprecated
public String getKeyService()

Deprecated

Returns:

the services that are permitted by the key.

getKeyStart

@Deprecated
public OffsetDateTime getKeyStart()

Deprecated

Returns:

the datetime when the key becomes active.

getKeyTenantId

@Deprecated
public String getKeyTenantId()

Deprecated

Returns:

the tenant ID of the key.

getKeyVersion

@Deprecated
public String getKeyVersion()

Deprecated

Returns:

the service version that created the key.

getResource

@Deprecated
public String getResource()

Deprecated

Returns:

The storage container or blob (only for BlobServiceSasSignatureValues).

Applies to