-
Notifications
You must be signed in to change notification settings - Fork 223
/
com.azure.storage.common.sas.BaseSasQueryParameters.yml
331 lines (331 loc) · 23.8 KB
/
com.azure.storage.common.sas.BaseSasQueryParameters.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
### 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.25.1