ShareServiceSasQueryParameters Class

Package:

com.azure.storage.file.share.sas

Maven Artifact:

com.azure:azure-storage-file-share:12.21.4

• java.lang.Object
• • com.azure.storage.common.sas.BaseSasQueryParameters
  • • com.azure.storage.file.share.sas.ShareServiceSasQueryParameters

@Deprecated
public final class ShareServiceSasQueryParameters
extends BaseSasQueryParameters

Note

This class has been deprecated. Please use the generateSas method on the desired file/share client after initializing ShareServiceSasSignatureValues.

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 ShareServiceSasSignatureValues type. Once generated, it can be set on a ShareFileClientBuilder 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
ShareServiceSasQueryParameters(Map<String,String[]> queryParamsMap, boolean removeSasParametersFromMap)	Deprecated Please use ShareServiceSasSignatureValues Creates a new ShareServiceSasQueryParameters object.

Method Summary

Modifier and Type	Method and Description
String	encode() Deprecated Please use the generateSas method on the desired file/share client after initializing ShareServiceSasSignatureValues. Encodes all SAS query parameters into a string that can be appended to a URL.
String	getCacheControl() Deprecated Please use ShareServiceSasSignatureValues
String	getContentDisposition() Deprecated Please use ShareServiceSasSignatureValues
String	getContentEncoding() Deprecated Please use ShareServiceSasSignatureValues
String	getContentLanguage() Deprecated Please use ShareServiceSasSignatureValues
String	getContentType() Deprecated Please use ShareServiceSasSignatureValues
String	getIdentifier() Deprecated Please use ShareServiceSasSignatureValues
String	getResource() Deprecated Please use ShareServiceSasSignatureValues

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

ShareServiceSasQueryParameters

@Deprecated
public ShareServiceSasQueryParameters(Map queryParamsMap, boolean removeSasParametersFromMap)

Deprecated

Please use ShareServiceSasSignatureValues

Creates a new ShareServiceSasQueryParameters 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 file/share client after initializing ShareServiceSasSignatureValues.

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

Overrides:

ShareServiceSasQueryParameters.encode()

Returns:

A String representing the SAS query parameters.

getCacheControl

@Deprecated
public String getCacheControl()

Deprecated

Please use ShareServiceSasSignatureValues

Returns:

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

getContentDisposition

@Deprecated
public String getContentDisposition()

Deprecated

Please use ShareServiceSasSignatureValues

Returns:

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

getContentEncoding

@Deprecated
public String getContentEncoding()

Deprecated

Please use ShareServiceSasSignatureValues

Returns:

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

getContentLanguage

@Deprecated
public String getContentLanguage()

Deprecated

Please use ShareServiceSasSignatureValues

Returns:

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

getContentType

@Deprecated
public String getContentType()

Deprecated

Please use ShareServiceSasSignatureValues

Returns:

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

getIdentifier

@Deprecated
public String getIdentifier()

Deprecated

Please use ShareServiceSasSignatureValues

Returns:

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

getResource

@Deprecated
public String getResource()

Deprecated

Please use ShareServiceSasSignatureValues

Returns:

The storage share or file (only for ShareServiceSasSignatureValues).