CommonSasQueryParameters (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.storage.common.sas.CommonSasQueryParameters

```
public class CommonSasQueryParameters
extends Object
```
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 URLParts type. NOTE: Instances of this class are immutable to ensure thread safety.

Constructor Summary

Constructors
Constructor and Description
`CommonSasQueryParameters(Map<String,String[]> queryParamsMap, boolean removeSasParametersFromMap)` Creates a new `CommonSasQueryParameters` object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`encode()` Encodes all SAS query parameters into a string that can be appended to a URL.
`String`	`getCacheControl()`
`String`	`getContentDisposition()`
`String`	`getContentEncoding()`
`String`	`getContentLanguage()`
`String`	`getContentType()`
`OffsetDateTime`	`getExpiryTime()`
`String`	`getIdentifier()`
`OffsetDateTime`	`getKeyExpiry()`
`String`	`getKeyObjectId()`
`String`	`getKeyService()`
`OffsetDateTime`	`getKeyStart()`
`String`	`getKeyTenantId()`
`String`	`getKeyVersion()`
`String`	`getPermissions()`
`SasProtocol`	`getProtocol()`
`String`	`getResource()`
`String`	`getResourceTypes()`
`SasIpRange`	`getSasIpRange()`
`String`	`getServices()`
`String`	`getSignature()`
`OffsetDateTime`	`getStartTime()`
`String`	`getVersion()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CommonSasQueryParameters
```
public CommonSasQueryParameters(Map<String,String[]> queryParamsMap,
                                boolean removeSasParametersFromMap)
```
    Creates a new CommonSasQueryParameters 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 Detail
  - encode
```
public String encode()
```
    Encodes all SAS query parameters into a string that can be appended to a URL.
    
    Returns:
    
    A String representing all SAS query parameters.
  - getIdentifier
```
public String getIdentifier()
```
    Returns:
    
    The signed identifier. Please see here for more information.
  - getResource
```
public String getResource()
```
    Returns:
    
    The storage resource.
  - getCacheControl
```
public String getCacheControl()
```
    Returns:
    
    The Cache-Control header value when a client accesses the resource with this sas token.
  - getContentDisposition
```
public String getContentDisposition()
```
    Returns:
    
    The Content-Disposition header value when a client accesses the resource with this sas token.
  - getContentEncoding
```
public String getContentEncoding()
```
    Returns:
    
    The Content-Encoding header value when a client accesses the resource with this sas token.
  - getContentLanguage
```
public String getContentLanguage()
```
    Returns:
    
    The Content-Language header value when a client accesses the resource with this sas token.
  - getContentType
```
public String getContentType()
```
    Returns:
    
    The Content-Type header value when a client accesses the resource with this sas token.
  - getKeyObjectId
```
public String getKeyObjectId()
```
    Returns:
    
    the object ID of the key.
  - getKeyTenantId
```
public String getKeyTenantId()
```
    Returns:
    
    the tenant ID of the key.
  - getKeyStart
```
public OffsetDateTime getKeyStart()
```
    Returns:
    
    the datetime when the key becomes active.
  - getKeyExpiry
```
public OffsetDateTime getKeyExpiry()
```
    Returns:
    
    the datetime when the key expires.
  - getKeyService
```
public String getKeyService()
```
    Returns:
    
    the services that are permitted by the key.
  - getKeyVersion
```
public String getKeyVersion()
```
    Returns:
    
    the service version that created the key.
  - getServices
```
public String getServices()
```
    Returns:
    
    The storage services being accessed (only for Account SAS). Please refer to AccountSasService for more details.
  - getResourceTypes
```
public String getResourceTypes()
```
    Returns:
    
    The storage resource types being accessed (only for Account SAS). Please refer to AccountSasResourceType for more details.
  - getVersion
```
public String getVersion()
```
    Returns:
    
    The storage version
  - getProtocol
```
public SasProtocol getProtocol()
```
    Returns:
    
    The allowed HTTP protocol(s) or null. Please refer to SasProtocol for more details.
  - getStartTime
```
public OffsetDateTime getStartTime()
```
    Returns:
    
    The start time for this SAS token or null.
  - getExpiryTime
```
public OffsetDateTime getExpiryTime()
```
    Returns:
    
    The expiry time for this SAS token.
  - getSasIpRange
```
public SasIpRange getSasIpRange()
```
    Returns:
    
    SasIpRange
  - getPermissions
```
public String getPermissions()
```
    Returns:
    
    Please refer to *SASPermission classes for more details.
  - getSignature
```
public String getSignature()
```
    Returns:
    
    The signature for the SAS token.

Class CommonSasQueryParameters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CommonSasQueryParameters

Method Detail

encode

getIdentifier

getResource

getCacheControl

getContentDisposition

getContentEncoding

getContentLanguage

getContentType

getKeyObjectId

getKeyTenantId

getKeyStart

getKeyExpiry

getKeyService

getKeyVersion

getServices

getResourceTypes

getVersion

getProtocol

getStartTime

getExpiryTime

getSasIpRange

getPermissions

getSignature