### 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 generateSas method on the desired client after initializing the appropriate SasSignatureValues object." inheritances: - "" inheritedClassMethods: - classRef: "java.lang.Object" methodsRef: - "clone" - "equals" - "finalize" - "getClass" - "hashCode" - "notify" - "notifyAll" - "toString" - "wait" - "wait" - "wait" syntax: "@Deprecated
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 object." deprecatedTag: "Please use SasSignatureValues" parameters: - description: "A String representing the storage version." name: "version" type: "String" - description: "A String representing the allowed HTTP protocol(s) or null." name: "protocol" type: "" - description: "A java.util.Date representing the start time for this SAS token or null." name: "startTime" type: "OffsetDateTime" - description: "A java.util.Date representing the expiry time for this SAS token." name: "expiryTime" type: "OffsetDateTime" - description: "A representing the range of valid IP addresses for this SAS token or\n null." name: "sasIpRange" type: "" - description: "A String representing the storage permissions or null." name: "permissions" type: "String" - description: "A String representing the signature for the SAS token." name: "signature" type: "String" syntax: "@Deprecated
public BaseSasQueryParameters(String version, SasProtocol protocol, OffsetDateTime startTime, OffsetDateTime expiryTime, SasIpRange sasIpRange, String permissions, String signature)" desc: "Creates a new object. These objects are only created internally by SASSignatureValues classes." hasDeprecatedTag: true - uid: "com.azure.storage.common.sas.BaseSasQueryParameters.BaseSasQueryParameters(java.util.Map,boolean)" fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.BaseSasQueryParameters(Map queryParamsMap, boolean removeSASParametersFromMap)" name: "BaseSasQueryParameters(Map queryParamsMap, boolean removeSASParametersFromMap)" nameWithType: "BaseSasQueryParameters.BaseSasQueryParameters(Map queryParamsMap, boolean removeSASParametersFromMap)" summary: "Creates a new object." deprecatedTag: "Please use SasSignatureValues" parameters: - description: "All query parameters for the request as key-value pairs" name: "queryParamsMap" type: "Map<String,String[]>" - description: "When true, the SAS query parameters will be removed from\n queryParamsMap" name: "removeSASParametersFromMap" type: "" syntax: "@Deprecated
public BaseSasQueryParameters(Map queryParamsMap, boolean removeSASParametersFromMap)" desc: "Creates a new 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: "OffsetDateTime" 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: "String" 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: "" 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: "" 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: "String" 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: "OffsetDateTime" 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: "String" syntax: "protected String version" desc: "The Storage version." methods: - uid: "com.azure.storage.common.sas.BaseSasQueryParameters.getQueryParameter(java.util.Map,java.lang.String,boolean,java.util.function.Function)" fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.getQueryParameter(Map parameters, String name, boolean remove, Function converter)" name: "getQueryParameter(Map parameters, String name, boolean remove, Function converter)" nameWithType: "BaseSasQueryParameters.getQueryParameter(Map parameters, String name, boolean remove, Function converter)" summary: "Helper method to get a query parameter" deprecatedTag: "Please use SasSignatureValues" modifiers: - "protected" parameters: - description: "A Map of parameters to values to search." name: "parameters" type: "Map<String,String[]>" - description: "The name of parameter to find." name: "name" type: "String" - description: "Whether or not to remove the parameter from the map." name: "remove" type: "" - description: "Function that transforms the value to a String." name: "converter" type: "Function<String,>" syntax: "@Deprecated
protected T getQueryParameter(Map parameters, String name, boolean remove, Function converter)" desc: "Helper method to get a query parameter" hasDeprecatedTag: true returns: description: "The object" type: "" - 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 generateSas method on the desired client after initializing the appropriate SasSignatureValues object." modifiers: - "abstract" syntax: "@Deprecated
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 String representing the SAS query parameters." type: "String" - 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 SasSignatureValues" modifiers: - "protected" parameters: - description: "The SAS date time." name: "dateTime" type: "OffsetDateTime" syntax: "@Deprecated
protected String formatQueryParameterDate(OffsetDateTime dateTime)" desc: "Formats date time SAS query parameters." hasDeprecatedTag: true returns: description: "A String representing the SAS date time." type: "String" - uid: "com.azure.storage.common.sas.BaseSasQueryParameters.getExpiryTime()" fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.getExpiryTime()" name: "getExpiryTime()" nameWithType: "BaseSasQueryParameters.getExpiryTime()" deprecatedTag: "Please use SasSignatureValues" syntax: "@Deprecated
public OffsetDateTime getExpiryTime()" hasDeprecatedTag: true returns: description: "The expiry time for this SAS token." type: "OffsetDateTime" - uid: "com.azure.storage.common.sas.BaseSasQueryParameters.getPermissions()" fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.getPermissions()" name: "getPermissions()" nameWithType: "BaseSasQueryParameters.getPermissions()" deprecatedTag: "Please use SasSignatureValues" syntax: "@Deprecated
public String getPermissions()" hasDeprecatedTag: true returns: description: "Please refer to *SASPermission classes for more details." type: "String" - uid: "com.azure.storage.common.sas.BaseSasQueryParameters.getProtocol()" fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.getProtocol()" name: "getProtocol()" nameWithType: "BaseSasQueryParameters.getProtocol()" deprecatedTag: "Please use SasSignatureValues" syntax: "@Deprecated
public SasProtocol getProtocol()" hasDeprecatedTag: true returns: description: "The allowed HTTP protocol(s) or null. Please refer to for more details." type: "" - uid: "com.azure.storage.common.sas.BaseSasQueryParameters.getQueryParameter(java.util.Map,java.lang.String,boolean)" fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.getQueryParameter(Map parameters, String name, boolean remove)" name: "getQueryParameter(Map parameters, String name, boolean remove)" nameWithType: "BaseSasQueryParameters.getQueryParameter(Map parameters, String name, boolean remove)" summary: "Helper method to get a query parameter" deprecatedTag: "Please use SasSignatureValues" modifiers: - "protected" parameters: - description: "A Map of parameters to values to search." name: "parameters" type: "Map<String,String[]>" - description: "The name of parameter to find." name: "name" type: "String" - description: "Whether or not to remove the parameter from the map." name: "remove" type: "" syntax: "@Deprecated
protected String getQueryParameter(Map parameters, String name, boolean remove)" desc: "Helper method to get a query parameter" hasDeprecatedTag: true returns: description: "A String representing the query parameter" type: "String" - uid: "com.azure.storage.common.sas.BaseSasQueryParameters.getSasIpRange()" fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.getSasIpRange()" name: "getSasIpRange()" nameWithType: "BaseSasQueryParameters.getSasIpRange()" deprecatedTag: "Please use SasSignatureValues" syntax: "@Deprecated
public SasIpRange getSasIpRange()" hasDeprecatedTag: true returns: description: "" type: "" - uid: "com.azure.storage.common.sas.BaseSasQueryParameters.getSignature()" fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.getSignature()" name: "getSignature()" nameWithType: "BaseSasQueryParameters.getSignature()" deprecatedTag: "Please use SasSignatureValues" syntax: "@Deprecated
public String getSignature()" hasDeprecatedTag: true returns: description: "The signature for the SAS token." type: "String" - uid: "com.azure.storage.common.sas.BaseSasQueryParameters.getStartTime()" fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.getStartTime()" name: "getStartTime()" nameWithType: "BaseSasQueryParameters.getStartTime()" deprecatedTag: "Please use SasSignatureValues" syntax: "@Deprecated
public OffsetDateTime getStartTime()" hasDeprecatedTag: true returns: description: "The start time for this SAS token or null." type: "OffsetDateTime" - uid: "com.azure.storage.common.sas.BaseSasQueryParameters.getVersion()" fullName: "com.azure.storage.common.sas.BaseSasQueryParameters.getVersion()" name: "getVersion()" nameWithType: "BaseSasQueryParameters.getVersion()" deprecatedTag: "Please use SasSignatureValues" syntax: "@Deprecated
public String getVersion()" hasDeprecatedTag: true returns: description: "The storage version" type: "String" - 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 SasSignatureValues" modifiers: - "protected" parameters: - description: "The StringBuilder to append to." name: "sb" type: "StringBuilder" - description: "The String parameter to append." name: "param" type: "String" - description: "The value of the parameter to append." name: "value" type: "Object" syntax: "@Deprecated
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