com.azure.storage.queue.sas

Class QueueServiceSasQueryParameters

java.lang.Object

com.azure.storage.common.sas.BaseSasQueryParameters

com.azure.storage.queue.sas.QueueServiceSasQueryParameters

Deprecated.

Please use the generateSas method on the desired queue client after initializing QueueServiceSasSignatureValues.

@Deprecated
public final class QueueServiceSasQueryParameters
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 QueueServiceSasSignatureValues type. Once generated, it can be set on a QueueClientBuilder 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
QueueServiceSasQueryParameters(Map<String,String[]> queryParametersMap, boolean removeSasParametersFromMap) Deprecated. Please use QueueServiceSasSignatureValues

Method Summary

Modifier and Type	Method and Description
String	encode() Deprecated. Please use the generateSas method on the desired queue client after initializing QueueServiceSasSignatureValues.
String	getIdentifier() Deprecated. Please use QueueServiceSasSignatureValues

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

QueueServiceSasQueryParameters

@Deprecated
public QueueServiceSasQueryParameters(Map<String,String[]> queryParametersMap,
                                                  boolean removeSasParametersFromMap)

Deprecated. Please use QueueServiceSasSignatureValues

Creates a new QueueServiceSasQueryParameters object.

Parameters:

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

removeSasParametersFromMap - When true, the SAS query parameters will be removed from queryParametersMap

Method Detail

getIdentifier

@Deprecated
public String getIdentifier()

Deprecated. Please use QueueServiceSasSignatureValues

Returns:

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

encode

@Deprecated
public String encode()

Deprecated. Please use the generateSas method on the desired queue client after initializing QueueServiceSasSignatureValues.

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 the SAS query parameters.