Package com.azure.storage.blob.sas
Class BlobServiceSasQueryParameters
- java.lang.Object
-
- com.azure.storage.common.sas.BaseSasQueryParameters
-
- com.azure.storage.blob.sas.BlobServiceSasQueryParameters
-
@Deprecated public final class BlobServiceSasQueryParameters extends BaseSasQueryParameters
Deprecated.Please use the generateSas method on the desired blob/container client after initializingBlobServiceSasSignatureValues
.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 theBlobServiceSasSignatureValues
type. Once generated, it can be set on aBlobClientBuilder
object to be constructed as part of a URL or it can be encoded into aString
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 Description BlobServiceSasQueryParameters(Map<String,String[]> queryParamsMap, boolean removeSasParametersFromMap)
Deprecated.Please useBlobServiceSasSignatureValues
-
Method Summary
-
Methods inherited from class com.azure.storage.common.sas.BaseSasQueryParameters
formatQueryParameterDate, getExpiryTime, getPermissions, getProtocol, getQueryParameter, getQueryParameter, getSasIpRange, getSignature, getStartTime, getVersion, tryAppendQueryParameter
-
-
-
-
Constructor Detail
-
BlobServiceSasQueryParameters
@Deprecated public BlobServiceSasQueryParameters(Map<String,String[]> queryParamsMap, boolean removeSasParametersFromMap)
Deprecated.Please useBlobServiceSasSignatureValues
Creates a newBlobServiceSasQueryParameters
object.- Parameters:
queryParamsMap
- All query parameters for the request as key-value pairsremoveSasParametersFromMap
- Whentrue
, the SAS query parameters will be removed from queryParamsMap
-
-
Method Detail
-
getIdentifier
@Deprecated public String getIdentifier()
Deprecated.Please useBlobServiceSasSignatureValues
- Returns:
- The signed identifier (only for
BlobServiceSasSignatureValues
) ornull
. Please see here for more information.
-
getResource
@Deprecated public String getResource()
Deprecated.Please useBlobServiceSasSignatureValues
- Returns:
- The storage container or blob (only for
BlobServiceSasSignatureValues
).
-
getCacheControl
@Deprecated public String getCacheControl()
Deprecated.Please useBlobServiceSasSignatureValues
- Returns:
- The Cache-Control header value when a client accesses the resource with this sas token.
-
getContentDisposition
@Deprecated public String getContentDisposition()
Deprecated.Please useBlobServiceSasSignatureValues
- Returns:
- The Content-Disposition header value when a client accesses the resource with this sas token.
-
getContentEncoding
@Deprecated public String getContentEncoding()
Deprecated.Please useBlobServiceSasSignatureValues
- Returns:
- The Content-Encoding header value when a client accesses the resource with this sas token.
-
getContentLanguage
@Deprecated public String getContentLanguage()
Deprecated.Please useBlobServiceSasSignatureValues
- Returns:
- The Content-Language header value when a client accesses the resource with this sas token.
-
getContentType
@Deprecated public String getContentType()
Deprecated.Please useBlobServiceSasSignatureValues
- Returns:
- The Content-Type header value when a client accesses the resource with this sas token.
-
getKeyObjectId
@Deprecated public String getKeyObjectId()
Deprecated.Please useBlobServiceSasSignatureValues
- Returns:
- the object ID of the key.
-
getKeyTenantId
@Deprecated public String getKeyTenantId()
Deprecated.Please useBlobServiceSasSignatureValues
- Returns:
- the tenant ID of the key.
-
getKeyStart
@Deprecated public OffsetDateTime getKeyStart()
Deprecated.Please useBlobServiceSasSignatureValues
- Returns:
- the datetime when the key becomes active.
-
getKeyExpiry
@Deprecated public OffsetDateTime getKeyExpiry()
Deprecated.Please useBlobServiceSasSignatureValues
- Returns:
- the datetime when the key expires.
-
getKeyService
@Deprecated public String getKeyService()
Deprecated.Please useBlobServiceSasSignatureValues
- Returns:
- the services that are permitted by the key.
-
getKeyVersion
@Deprecated public String getKeyVersion()
Deprecated.Please useBlobServiceSasSignatureValues
- Returns:
- the service version that created the key.
-
encode
@Deprecated public String encode()
Deprecated.Please use the generateSas method on the desired blob/container client after initializingBlobServiceSasSignatureValues
.Encodes all SAS query parameters into a string that can be appended to a URL.- Specified by:
encode
in classBaseSasQueryParameters
- Returns:
- A
String
representing the SAS query parameters.
-
-