89 строки
11 KiB
YAML
89 строки
11 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.storage.queue.sas.QueueServiceSasQueryParameters"
|
|
fullName: "com.azure.storage.queue.sas.QueueServiceSasQueryParameters"
|
|
name: "QueueServiceSasQueryParameters"
|
|
nameWithType: "QueueServiceSasQueryParameters"
|
|
summary: "Represents the components that make up an Azure Storage SAS' query parameters."
|
|
deprecatedTag: "Please use the generate<wbr>Sas method on the desired queue client after initializing <xref uid=\"com.azure.storage.queue.sas.QueueServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueueServiceSasSignatureValues\"></xref>."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.common.sas.BaseSasQueryParameters?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.azure.storage.common.sas.BaseSasQueryParameters?alt=com.azure.storage.common.sas.BaseSasQueryParameters&text=BaseSasQueryParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"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>)?alt=com.azure.storage.common.sas.BaseSasQueryParameters.<T>getQueryParameter&text=<T>getQueryParameter\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.common.sas.BaseSasQueryParameters.encode()?alt=com.azure.storage.common.sas.BaseSasQueryParameters.encode&text=encode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.common.sas.BaseSasQueryParameters.formatQueryParameterDate(java.time.OffsetDateTime)?alt=com.azure.storage.common.sas.BaseSasQueryParameters.formatQueryParameterDate&text=formatQueryParameterDate\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.common.sas.BaseSasQueryParameters.getExpiryTime()?alt=com.azure.storage.common.sas.BaseSasQueryParameters.getExpiryTime&text=getExpiryTime\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.common.sas.BaseSasQueryParameters.getPermissions()?alt=com.azure.storage.common.sas.BaseSasQueryParameters.getPermissions&text=getPermissions\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.common.sas.BaseSasQueryParameters.getProtocol()?alt=com.azure.storage.common.sas.BaseSasQueryParameters.getProtocol&text=getProtocol\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.common.sas.BaseSasQueryParameters.getQueryParameter(java.util.Map<java.lang.String,java.lang.String[]>,java.lang.String,boolean)?alt=com.azure.storage.common.sas.BaseSasQueryParameters.getQueryParameter&text=getQueryParameter\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.common.sas.BaseSasQueryParameters.getSasIpRange()?alt=com.azure.storage.common.sas.BaseSasQueryParameters.getSasIpRange&text=getSasIpRange\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.common.sas.BaseSasQueryParameters.getSignature()?alt=com.azure.storage.common.sas.BaseSasQueryParameters.getSignature&text=getSignature\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.common.sas.BaseSasQueryParameters.getStartTime()?alt=com.azure.storage.common.sas.BaseSasQueryParameters.getStartTime&text=getStartTime\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.common.sas.BaseSasQueryParameters.getVersion()?alt=com.azure.storage.common.sas.BaseSasQueryParameters.getVersion&text=getVersion\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.common.sas.BaseSasQueryParameters.tryAppendQueryParameter(java.lang.StringBuilder,java.lang.String,java.lang.Object)?alt=com.azure.storage.common.sas.BaseSasQueryParameters.tryAppendQueryParameter&text=tryAppendQueryParameter\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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 final class **QueueServiceSasQueryParameters**</br> extends <xref href=\"com.azure.storage.common.sas.BaseSasQueryParameters?alt=com.azure.storage.common.sas.BaseSasQueryParameters&text=BaseSasQueryParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.azure.storage.queue.sas.QueueServiceSasQueryParameters.QueueServiceSasQueryParameters(java.util.Map<java.lang.String,java.lang.String[]>,boolean)"
|
|
fullName: "com.azure.storage.queue.sas.QueueServiceSasQueryParameters.QueueServiceSasQueryParameters(Map<String,String[]> queryParametersMap, boolean removeSasParametersFromMap)"
|
|
name: "QueueServiceSasQueryParameters(Map<String,String[]> queryParametersMap, boolean removeSasParametersFromMap)"
|
|
nameWithType: "QueueServiceSasQueryParameters.QueueServiceSasQueryParameters(Map<String,String[]> queryParametersMap, boolean removeSasParametersFromMap)"
|
|
summary: "Creates a new <xref uid=\"com.azure.storage.queue.sas.QueueServiceSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueueServiceSasQueryParameters\"></xref> object."
|
|
deprecatedTag: "Please use <xref uid=\"com.azure.storage.queue.sas.QueueServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueueServiceSasSignatureValues\"></xref>"
|
|
parameters:
|
|
- description: "All query parameters for the request as key-value pairs"
|
|
name: "queryParametersMap"
|
|
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 <code>queryParametersMap</code>"
|
|
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 QueueServiceSasQueryParameters(Map<String,String[]> queryParametersMap, boolean removeSasParametersFromMap)"
|
|
desc: "Creates a new <xref uid=\"com.azure.storage.queue.sas.QueueServiceSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueueServiceSasQueryParameters\"></xref> object."
|
|
hasDeprecatedTag: true
|
|
methods:
|
|
- uid: "com.azure.storage.queue.sas.QueueServiceSasQueryParameters.encode()"
|
|
fullName: "com.azure.storage.queue.sas.QueueServiceSasQueryParameters.encode()"
|
|
name: "encode()"
|
|
nameWithType: "QueueServiceSasQueryParameters.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 queue client after initializing <xref uid=\"com.azure.storage.queue.sas.QueueServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueueServiceSasSignatureValues\"></xref>."
|
|
overridden: "com.azure.storage.common.sas.BaseSasQueryParameters.encode()"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public 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.queue.sas.QueueServiceSasQueryParameters.getIdentifier()"
|
|
fullName: "com.azure.storage.queue.sas.QueueServiceSasQueryParameters.getIdentifier()"
|
|
name: "getIdentifier()"
|
|
nameWithType: "QueueServiceSasQueryParameters.getIdentifier()"
|
|
summary: "Gets the signed identifier (only for <xref uid=\"com.azure.storage.queue.sas.QueueServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueueServiceSasSignatureValues\"></xref>) or `null`."
|
|
deprecatedTag: "Please use <xref uid=\"com.azure.storage.queue.sas.QueueServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueueServiceSasSignatureValues\"></xref>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public String getIdentifier()"
|
|
desc: "Gets the signed identifier (only for <xref uid=\"com.azure.storage.queue.sas.QueueServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueueServiceSasSignatureValues\"></xref>) or `null`."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "The signed identifier (only for <xref uid=\"com.azure.storage.queue.sas.QueueServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueueServiceSasSignatureValues\"></xref>) or <code>null</code>. Please see\n <a href=\"https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy\">here</a>\n for more information."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
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 <xref uid=\"com.azure.storage.queue.sas.QueueServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueueServiceSasSignatureValues\"></xref> type. Once generated, it can be set on a <xref uid=\"com.azure.storage.queue.QueueClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"QueueClientBuilder\"></xref> 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.queue.sas"
|
|
artifact: com.azure:azure-storage-queue:12.23.0
|