Class ShareServiceSasQueryParameters

java.lang.Object
com.azure.storage.common.sas.BaseSasQueryParameters
com.azure.storage.file.share.sas.ShareServiceSasQueryParameters
@Deprecated public final class ShareServiceSasQueryParameters extends com.azure.storage.common.sas.BaseSasQueryParameters
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 Details

    • ShareServiceSasQueryParameters

      @Deprecated public ShareServiceSasQueryParameters(Map<String,String[]> 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

    • getIdentifier

      @Deprecated public String getIdentifier()
      Deprecated.
      Please use ShareServiceSasSignatureValues
      Gets the signed identifier (only for ShareServiceSasSignatureValues) or null.
      Returns:
      The signed identifier (only for ShareServiceSasSignatureValues) or null. Please see here for more information.

    • getResource

      @Deprecated public String getResource()
      Deprecated.
      Please use ShareServiceSasSignatureValues
      Gets the storage share or file (only for ShareServiceSasSignatureValues).
      Returns:
      The storage share or file (only for ShareServiceSasSignatureValues).

    • getCacheControl

      @Deprecated public String getCacheControl()
      Deprecated.
      Please use ShareServiceSasSignatureValues
      Gets the Cache-Control header value when a client accesses the resource with this sas token.
      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
      Gets the Content-Disposition header value when a client accesses the resource with this sas token.
      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
      Gets the Content-Encoding header value when a client accesses the resource with this sas token.
      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
      Gets the Content-Language header value when a client accesses the resource with this sas token.
      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
      Gets the Content-Type header value when a client accesses the resource with this sas token.
      Returns:
      The Content-Type header value when a client accesses the resource with this sas token.

    • 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.
      Specified by:
      encode in class com.azure.storage.common.sas.BaseSasQueryParameters
      Returns:
      A String representing the SAS query parameters.