332 строки
24 KiB
YAML
332 строки
24 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.storage.common.sas.BaseSasQueryParameters"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters"
|
|
name: "BaseSasQueryParameters"
|
|
nameWithType: "BaseSasQueryParameters"
|
|
summary: "Represents the components that make up an Azure Storage SAS' query parameters."
|
|
deprecatedTag: "Please use the generate<wbr>Sas method on the desired client after initializing the appropriate Sas<wbr>Signature<wbr>Values object."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public abstract class **BaseSasQueryParameters**"
|
|
constructors:
|
|
- uid: "com.azure.storage.common.sas.BaseSasQueryParameters.BaseSasQueryParameters(java.lang.String,com.azure.storage.common.sas.SasProtocol,java.time.OffsetDateTime,java.time.OffsetDateTime,com.azure.storage.common.sas.SasIpRange,java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.BaseSasQueryParameters(String version, SasProtocol protocol, OffsetDateTime startTime, OffsetDateTime expiryTime, SasIpRange sasIpRange, String permissions, String signature)"
|
|
name: "BaseSasQueryParameters(String version, SasProtocol protocol, OffsetDateTime startTime, OffsetDateTime expiryTime, SasIpRange sasIpRange, String permissions, String signature)"
|
|
nameWithType: "BaseSasQueryParameters.BaseSasQueryParameters(String version, SasProtocol protocol, OffsetDateTime startTime, OffsetDateTime expiryTime, SasIpRange sasIpRange, String permissions, String signature)"
|
|
summary: "Creates a new <xref uid=\"com.azure.storage.common.sas.BaseSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BaseSasQueryParameters\"></xref> object."
|
|
deprecatedTag: "Please use Sas<wbr>Signature<wbr>Values"
|
|
parameters:
|
|
- description: "A <code>String</code> representing the storage version."
|
|
name: "version"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "A <code>String</code> representing the allowed HTTP protocol(s) or <code>null</code>."
|
|
name: "protocol"
|
|
type: "<xref href=\"com.azure.storage.common.sas.SasProtocol?alt=com.azure.storage.common.sas.SasProtocol&text=SasProtocol\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "A <code>java.util.Date</code> representing the start time for this SAS token or <code>null</code>."
|
|
name: "startTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- description: "A <code>java.util.Date</code> representing the expiry time for this SAS token."
|
|
name: "expiryTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- description: "A <xref uid=\"com.azure.storage.common.sas.SasIpRange\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SasIpRange\"></xref> representing the range of valid IP addresses for this SAS token or\n <code>null</code>."
|
|
name: "sasIpRange"
|
|
type: "<xref href=\"com.azure.storage.common.sas.SasIpRange?alt=com.azure.storage.common.sas.SasIpRange&text=SasIpRange\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "A <code>String</code> representing the storage permissions or <code>null</code>."
|
|
name: "permissions"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "A <code>String</code> representing the signature for the SAS token."
|
|
name: "signature"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public BaseSasQueryParameters(String version, SasProtocol protocol, OffsetDateTime startTime, OffsetDateTime expiryTime, SasIpRange sasIpRange, String permissions, String signature)"
|
|
desc: "Creates a new <xref uid=\"com.azure.storage.common.sas.BaseSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BaseSasQueryParameters\"></xref> object. These objects are only created internally by SASSignatureValues classes."
|
|
hasDeprecatedTag: true
|
|
- uid: "com.azure.storage.common.sas.BaseSasQueryParameters.BaseSasQueryParameters(java.util.Map<java.lang.String,java.lang.String[]>,boolean)"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.BaseSasQueryParameters(Map<String,String[]> queryParamsMap, boolean removeSASParametersFromMap)"
|
|
name: "BaseSasQueryParameters(Map<String,String[]> queryParamsMap, boolean removeSASParametersFromMap)"
|
|
nameWithType: "BaseSasQueryParameters.BaseSasQueryParameters(Map<String,String[]> queryParamsMap, boolean removeSASParametersFromMap)"
|
|
summary: "Creates a new <xref uid=\"com.azure.storage.common.sas.BaseSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BaseSasQueryParameters\"></xref> object."
|
|
deprecatedTag: "Please use Sas<wbr>Signature<wbr>Values"
|
|
parameters:
|
|
- description: "All query parameters for the request as key-value pairs"
|
|
name: "queryParamsMap"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>[]>"
|
|
- description: "When <code>true</code>, the SAS query parameters will be removed from\n queryParamsMap"
|
|
name: "removeSASParametersFromMap"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public BaseSasQueryParameters(Map<String,String[]> queryParamsMap, boolean removeSASParametersFromMap)"
|
|
desc: "Creates a new <xref uid=\"com.azure.storage.common.sas.BaseSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BaseSasQueryParameters\"></xref> object."
|
|
hasDeprecatedTag: true
|
|
fields:
|
|
- uid: "com.azure.storage.common.sas.BaseSasQueryParameters.expiryTime"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.expiryTime"
|
|
name: "expiryTime"
|
|
nameWithType: "BaseSasQueryParameters.expiryTime"
|
|
summary: "The end time for the SAS's validity."
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
syntax: "protected OffsetDateTime expiryTime"
|
|
desc: "The end time for the SAS's validity."
|
|
- uid: "com.azure.storage.common.sas.BaseSasQueryParameters.permissions"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.permissions"
|
|
name: "permissions"
|
|
nameWithType: "BaseSasQueryParameters.permissions"
|
|
summary: "The permissions of the SAS."
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "protected String permissions"
|
|
desc: "The permissions of the SAS."
|
|
- uid: "com.azure.storage.common.sas.BaseSasQueryParameters.protocol"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.protocol"
|
|
name: "protocol"
|
|
nameWithType: "BaseSasQueryParameters.protocol"
|
|
summary: "The allowed HTTP/HTTPS protocols."
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<xref href=\"com.azure.storage.common.sas.SasProtocol?alt=com.azure.storage.common.sas.SasProtocol&text=SasProtocol\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected SasProtocol protocol"
|
|
desc: "The allowed HTTP/HTTPS protocols."
|
|
- uid: "com.azure.storage.common.sas.BaseSasQueryParameters.sasIpRange"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.sasIpRange"
|
|
name: "sasIpRange"
|
|
nameWithType: "BaseSasQueryParameters.sasIpRange"
|
|
summary: "The IP range that the SAS validates."
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<xref href=\"com.azure.storage.common.sas.SasIpRange?alt=com.azure.storage.common.sas.SasIpRange&text=SasIpRange\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected SasIpRange sasIpRange"
|
|
desc: "The IP range that the SAS validates."
|
|
- uid: "com.azure.storage.common.sas.BaseSasQueryParameters.signature"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.signature"
|
|
name: "signature"
|
|
nameWithType: "BaseSasQueryParameters.signature"
|
|
summary: "The signature of the SAS."
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "protected String signature"
|
|
desc: "The signature of the SAS."
|
|
- uid: "com.azure.storage.common.sas.BaseSasQueryParameters.startTime"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.startTime"
|
|
name: "startTime"
|
|
nameWithType: "BaseSasQueryParameters.startTime"
|
|
summary: "The start time for the SAS's validity."
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
syntax: "protected OffsetDateTime startTime"
|
|
desc: "The start time for the SAS's validity."
|
|
- uid: "com.azure.storage.common.sas.BaseSasQueryParameters.version"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.version"
|
|
name: "version"
|
|
nameWithType: "BaseSasQueryParameters.version"
|
|
summary: "The Storage version."
|
|
modifiers:
|
|
- "protected"
|
|
field:
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "protected String version"
|
|
desc: "The Storage version."
|
|
methods:
|
|
- uid: "com.azure.storage.common.sas.BaseSasQueryParameters.<T>getQueryParameter(java.util.Map<java.lang.String,java.lang.String[]>,java.lang.String,boolean,java.util.function.Function<java.lang.String,T>)"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.getQueryParameter(Map<String,String[]> parameters, String name, boolean remove, Function<String,T> converter)"
|
|
name: "getQueryParameter(Map<String,String[]> parameters, String name, boolean remove, Function<String,T> converter)"
|
|
nameWithType: "BaseSasQueryParameters.getQueryParameter(Map<String,String[]> parameters, String name, boolean remove, Function<String,T> converter)"
|
|
summary: "Helper method to get a query parameter"
|
|
deprecatedTag: "Please use Sas<wbr>Signature<wbr>Values"
|
|
modifiers:
|
|
- "protected"
|
|
parameters:
|
|
- description: "A <code>Map</code> of parameters to values to search."
|
|
name: "parameters"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>[]>"
|
|
- description: "The name of parameter to find."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Whether or not to remove the parameter from the map."
|
|
name: "remove"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Function that transforms the value to a String."
|
|
name: "converter"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Function.html\">Function</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>protected T <T>getQueryParameter(Map<String,String[]> parameters, String name, boolean remove, Function<String,T> converter)"
|
|
desc: "Helper method to get a query parameter"
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "The object"
|
|
type: "<xref href=\"T?alt=T&text=T\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.common.sas.BaseSasQueryParameters.encode()"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.encode()"
|
|
name: "encode()"
|
|
nameWithType: "BaseSasQueryParameters.encode()"
|
|
summary: "Encodes all SAS query parameters into a string that can be appended to a URL."
|
|
deprecatedTag: "Please use the generate<wbr>Sas method on the desired client after initializing the appropriate Sas<wbr>Signature<wbr>Values object."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public abstract String encode()"
|
|
desc: "Encodes all SAS query parameters into a string that can be appended to a URL."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "A <code>String</code> representing the SAS query parameters."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.common.sas.BaseSasQueryParameters.formatQueryParameterDate(java.time.OffsetDateTime)"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.formatQueryParameterDate(OffsetDateTime dateTime)"
|
|
name: "formatQueryParameterDate(OffsetDateTime dateTime)"
|
|
nameWithType: "BaseSasQueryParameters.formatQueryParameterDate(OffsetDateTime dateTime)"
|
|
summary: "Formats date time SAS query parameters."
|
|
deprecatedTag: "Please use Sas<wbr>Signature<wbr>Values"
|
|
modifiers:
|
|
- "protected"
|
|
parameters:
|
|
- description: "The SAS date time."
|
|
name: "dateTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>protected String formatQueryParameterDate(OffsetDateTime dateTime)"
|
|
desc: "Formats date time SAS query parameters."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "A String representing the SAS date time."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.common.sas.BaseSasQueryParameters.getExpiryTime()"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.getExpiryTime()"
|
|
name: "getExpiryTime()"
|
|
nameWithType: "BaseSasQueryParameters.getExpiryTime()"
|
|
deprecatedTag: "Please use Sas<wbr>Signature<wbr>Values"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public OffsetDateTime getExpiryTime()"
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "The expiry time for this SAS token."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- uid: "com.azure.storage.common.sas.BaseSasQueryParameters.getPermissions()"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.getPermissions()"
|
|
name: "getPermissions()"
|
|
nameWithType: "BaseSasQueryParameters.getPermissions()"
|
|
deprecatedTag: "Please use Sas<wbr>Signature<wbr>Values"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public String getPermissions()"
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "Please refer to *SASPermission classes for more details."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.common.sas.BaseSasQueryParameters.getProtocol()"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.getProtocol()"
|
|
name: "getProtocol()"
|
|
nameWithType: "BaseSasQueryParameters.getProtocol()"
|
|
deprecatedTag: "Please use Sas<wbr>Signature<wbr>Values"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public SasProtocol getProtocol()"
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "The allowed HTTP protocol(s) or <code>null</code>. Please refer to <xref uid=\"com.azure.storage.common.sas.SasProtocol\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SasProtocol\"></xref> for more details."
|
|
type: "<xref href=\"com.azure.storage.common.sas.SasProtocol?alt=com.azure.storage.common.sas.SasProtocol&text=SasProtocol\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.common.sas.BaseSasQueryParameters.getQueryParameter(java.util.Map<java.lang.String,java.lang.String[]>,java.lang.String,boolean)"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.getQueryParameter(Map<String,String[]> parameters, String name, boolean remove)"
|
|
name: "getQueryParameter(Map<String,String[]> parameters, String name, boolean remove)"
|
|
nameWithType: "BaseSasQueryParameters.getQueryParameter(Map<String,String[]> parameters, String name, boolean remove)"
|
|
summary: "Helper method to get a query parameter"
|
|
deprecatedTag: "Please use Sas<wbr>Signature<wbr>Values"
|
|
modifiers:
|
|
- "protected"
|
|
parameters:
|
|
- description: "A <code>Map</code> of parameters to values to search."
|
|
name: "parameters"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>[]>"
|
|
- description: "The name of parameter to find."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Whether or not to remove the parameter from the map."
|
|
name: "remove"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>protected String getQueryParameter(Map<String,String[]> parameters, String name, boolean remove)"
|
|
desc: "Helper method to get a query parameter"
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "A String representing the query parameter"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.common.sas.BaseSasQueryParameters.getSasIpRange()"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.getSasIpRange()"
|
|
name: "getSasIpRange()"
|
|
nameWithType: "BaseSasQueryParameters.getSasIpRange()"
|
|
deprecatedTag: "Please use Sas<wbr>Signature<wbr>Values"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public SasIpRange getSasIpRange()"
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "<xref uid=\"com.azure.storage.common.sas.SasIpRange\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SasIpRange\"></xref>"
|
|
type: "<xref href=\"com.azure.storage.common.sas.SasIpRange?alt=com.azure.storage.common.sas.SasIpRange&text=SasIpRange\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.common.sas.BaseSasQueryParameters.getSignature()"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.getSignature()"
|
|
name: "getSignature()"
|
|
nameWithType: "BaseSasQueryParameters.getSignature()"
|
|
deprecatedTag: "Please use Sas<wbr>Signature<wbr>Values"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public String getSignature()"
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "The signature for the SAS token."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.common.sas.BaseSasQueryParameters.getStartTime()"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.getStartTime()"
|
|
name: "getStartTime()"
|
|
nameWithType: "BaseSasQueryParameters.getStartTime()"
|
|
deprecatedTag: "Please use Sas<wbr>Signature<wbr>Values"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public OffsetDateTime getStartTime()"
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "The start time for this SAS token or <code>null</code>."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- uid: "com.azure.storage.common.sas.BaseSasQueryParameters.getVersion()"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.getVersion()"
|
|
name: "getVersion()"
|
|
nameWithType: "BaseSasQueryParameters.getVersion()"
|
|
deprecatedTag: "Please use Sas<wbr>Signature<wbr>Values"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public String getVersion()"
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "The storage version"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.common.sas.BaseSasQueryParameters.tryAppendQueryParameter(java.lang.StringBuilder,java.lang.String,java.lang.Object)"
|
|
fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.tryAppendQueryParameter(StringBuilder sb, String param, Object value)"
|
|
name: "tryAppendQueryParameter(StringBuilder sb, String param, Object value)"
|
|
nameWithType: "BaseSasQueryParameters.tryAppendQueryParameter(StringBuilder sb, String param, Object value)"
|
|
summary: "Shared helper method to append a SAS query parameter."
|
|
deprecatedTag: "Please use Sas<wbr>Signature<wbr>Values"
|
|
modifiers:
|
|
- "protected"
|
|
parameters:
|
|
- description: "The <code>StringBuilder</code> to append to."
|
|
name: "sb"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html\">StringBuilder</a>"
|
|
- description: "The <code>String</code> parameter to append."
|
|
name: "param"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The value of the parameter to append."
|
|
name: "value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>protected void tryAppendQueryParameter(StringBuilder sb, String param, Object value)"
|
|
desc: "Shared helper method to append a SAS query parameter."
|
|
hasDeprecatedTag: true
|
|
type: "class"
|
|
desc: "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 SASSignatureValues type. Once generated, it can be set on a ClientBuilder 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."
|
|
hasDeprecatedTag: true
|
|
metadata: {}
|
|
package: "com.azure.storage.common.sas"
|
|
artifact: com.azure:azure-storage-common:12.26.1
|