-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.azure.storage.blob.BlobUrlParts.yml
337 lines (337 loc) · 26 KB
/
com.azure.storage.blob.BlobUrlParts.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
332
333
334
335
336
337
### YamlMime:JavaType
uid: "com.azure.storage.blob.BlobUrlParts"
fullName: "com.azure.storage.blob.BlobUrlParts"
name: "BlobUrlParts"
nameWithType: "BlobUrlParts"
summary: "This class represents the components that make up an Azure Storage Container/Blob URL."
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: "public final class **BlobUrlParts**"
constructors:
- uid: "com.azure.storage.blob.BlobUrlParts.BlobUrlParts()"
fullName: "com.azure.storage.blob.BlobUrlParts.BlobUrlParts()"
name: "BlobUrlParts()"
nameWithType: "BlobUrlParts.BlobUrlParts()"
summary: "Initializes a Blob<wbr>Url<wbr>Parts object which helps aid in the construction of a Blob Storage URL."
syntax: "public BlobUrlParts()"
desc: "Initializes a BlobUrlParts object which helps aid in the construction of a Blob Storage URL."
methods:
- uid: "com.azure.storage.blob.BlobUrlParts.getAccountName()"
fullName: "com.azure.storage.blob.BlobUrlParts.getAccountName()"
name: "getAccountName()"
nameWithType: "BlobUrlParts.getAccountName()"
summary: "Gets the accountname, ex."
syntax: "public String getAccountName()"
desc: "Gets the accountname, ex. \"myaccountname\"."
returns:
description: "the account name."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.BlobUrlParts.getBlobContainerName()"
fullName: "com.azure.storage.blob.BlobUrlParts.getBlobContainerName()"
name: "getBlobContainerName()"
nameWithType: "BlobUrlParts.getBlobContainerName()"
summary: "Gets the container name that will be used as part of the URL path."
syntax: "public String getBlobContainerName()"
desc: "Gets the container name that will be used as part of the URL path."
returns:
description: "the container name."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.BlobUrlParts.getBlobName()"
fullName: "com.azure.storage.blob.BlobUrlParts.getBlobName()"
name: "getBlobName()"
nameWithType: "BlobUrlParts.getBlobName()"
summary: "Decodes and gets the blob name that will be used as part of the URL path."
syntax: "public String getBlobName()"
desc: "Decodes and gets the blob name that will be used as part of the URL path."
returns:
description: "the decoded blob name."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.BlobUrlParts.getCommonSasQueryParameters()"
fullName: "com.azure.storage.blob.BlobUrlParts.getCommonSasQueryParameters()"
name: "getCommonSasQueryParameters()"
nameWithType: "BlobUrlParts.getCommonSasQueryParameters()"
summary: "Gets the <xref uid=\"com.azure.storage.common.sas.CommonSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CommonSasQueryParameters\"></xref> representing the SAS query parameters that will be used to generate the SAS token for this URL."
syntax: "public CommonSasQueryParameters getCommonSasQueryParameters()"
desc: "Gets the <xref uid=\"com.azure.storage.common.sas.CommonSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CommonSasQueryParameters\"></xref> representing the SAS query parameters that will be used to generate the SAS token for this URL."
returns:
description: "the <xref uid=\"com.azure.storage.common.sas.CommonSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CommonSasQueryParameters\"></xref> of the URL"
type: "<xref href=\"com.azure.storage.common.sas.CommonSasQueryParameters?alt=com.azure.storage.common.sas.CommonSasQueryParameters&text=CommonSasQueryParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.BlobUrlParts.getHost()"
fullName: "com.azure.storage.blob.BlobUrlParts.getHost()"
name: "getHost()"
nameWithType: "BlobUrlParts.getHost()"
summary: "Gets the URL host, ex."
syntax: "public String getHost()"
desc: "Gets the URL host, ex. \"account.blob.core.windows.net\" or \"127.0.0.1:10000\"."
returns:
description: "the URL host."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.BlobUrlParts.getSasQueryParameters()"
fullName: "com.azure.storage.blob.BlobUrlParts.getSasQueryParameters()"
name: "getSasQueryParameters()"
nameWithType: "BlobUrlParts.getSasQueryParameters()"
summary: "Gets the <xref uid=\"com.azure.storage.blob.sas.BlobServiceSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobServiceSasQueryParameters\"></xref> representing the SAS query parameters"
deprecatedTag: "Please use <xref uid=\"com.azure.storage.blob.BlobUrlParts.getCommonSasQueryParameters()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getCommonSasQueryParameters()\"></xref>"
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public BlobServiceSasQueryParameters getSasQueryParameters()"
desc: "Gets the <xref uid=\"com.azure.storage.blob.sas.BlobServiceSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobServiceSasQueryParameters\"></xref> representing the SAS query parameters"
hasDeprecatedTag: true
returns:
description: "the <xref uid=\"com.azure.storage.blob.sas.BlobServiceSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobServiceSasQueryParameters\"></xref> of the URL"
type: "<xref href=\"com.azure.storage.blob.sas.BlobServiceSasQueryParameters?alt=com.azure.storage.blob.sas.BlobServiceSasQueryParameters&text=BlobServiceSasQueryParameters\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.BlobUrlParts.getScheme()"
fullName: "com.azure.storage.blob.BlobUrlParts.getScheme()"
name: "getScheme()"
nameWithType: "BlobUrlParts.getScheme()"
summary: "Gets the URL scheme, ex."
syntax: "public String getScheme()"
desc: "Gets the URL scheme, ex. \"https\"."
returns:
description: "the URL scheme."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.BlobUrlParts.getSnapshot()"
fullName: "com.azure.storage.blob.BlobUrlParts.getSnapshot()"
name: "getSnapshot()"
nameWithType: "BlobUrlParts.getSnapshot()"
summary: "Gets the snapshot identifier that will be used as part of the query string if set."
syntax: "public String getSnapshot()"
desc: "Gets the snapshot identifier that will be used as part of the query string if set."
returns:
description: "the snapshot identifier."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.BlobUrlParts.getUnparsedParameters()"
fullName: "com.azure.storage.blob.BlobUrlParts.getUnparsedParameters()"
name: "getUnparsedParameters()"
nameWithType: "BlobUrlParts.getUnparsedParameters()"
summary: "Gets the query string parameters that aren't part of the SAS token that will be used by this URL."
syntax: "public Map<String,String[]> getUnparsedParameters()"
desc: "Gets the query string parameters that aren't part of the SAS token that will be used by this URL."
returns:
description: "the non-SAS token query string values."
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>[]>"
- uid: "com.azure.storage.blob.BlobUrlParts.getVersionId()"
fullName: "com.azure.storage.blob.BlobUrlParts.getVersionId()"
name: "getVersionId()"
nameWithType: "BlobUrlParts.getVersionId()"
summary: "Gets the version identifier that will be used as part of the query string if set."
syntax: "public String getVersionId()"
desc: "Gets the version identifier that will be used as part of the query string if set."
returns:
description: "the version identifier."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.BlobUrlParts.parse(java.lang.String)"
fullName: "com.azure.storage.blob.BlobUrlParts.parse(String url)"
name: "parse(String url)"
nameWithType: "BlobUrlParts.parse(String url)"
summary: "Parses a string into a Blob<wbr>Url<wbr>Parts."
modifiers:
- "static"
parameters:
- description: "The <code>URL</code> to be parsed."
name: "url"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public static BlobUrlParts parse(String url)"
desc: "Parses a string into a BlobUrlParts.\n\nQuery parameters will be parsed into two properties, <xref uid=\"com.azure.storage.blob.sas.BlobServiceSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobServiceSasQueryParameters\"></xref> which contains all SAS token related values and <xref uid=\"com.azure.storage.blob.BlobUrlParts.getUnparsedParameters()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"unparsedParameters\"></xref> which is all other query parameters.\n\nIf a URL points to a blob in the root container, and the root container is referenced implicitly, i.e. there is no path element for the container, the name of this blob in the root container will be set as the containerName field in the resulting `BlobURLParts`."
returns:
description: "A <xref uid=\"com.azure.storage.blob.BlobUrlParts\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobUrlParts\"></xref> object containing all the components of a BlobURL."
type: "<xref href=\"com.azure.storage.blob.BlobUrlParts?alt=com.azure.storage.blob.BlobUrlParts&text=BlobUrlParts\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.BlobUrlParts.parse(java.net.URL)"
fullName: "com.azure.storage.blob.BlobUrlParts.parse(URL url)"
name: "parse(URL url)"
nameWithType: "BlobUrlParts.parse(URL url)"
summary: "Parses an existing URL into a Blob<wbr>Url<wbr>Parts."
modifiers:
- "static"
parameters:
- description: "The <code>URL</code> to be parsed."
name: "url"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/URL.html\">URL</a>"
syntax: "public static BlobUrlParts parse(URL url)"
desc: "Parses an existing URL into a BlobUrlParts.\n\nQuery parameters will be parsed into two properties, <xref uid=\"com.azure.storage.blob.sas.BlobServiceSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobServiceSasQueryParameters\"></xref> which contains all SAS token related values and <xref uid=\"com.azure.storage.blob.BlobUrlParts.getUnparsedParameters()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"unparsedParameters\"></xref> which is all other query parameters.\n\nIf a URL points to a blob in the root container, and the root container is referenced implicitly, i.e. there is no path element for the container, the name of this blob in the root container will be set as the containerName field in the resulting `BlobURLParts`."
returns:
description: "A <xref uid=\"com.azure.storage.blob.BlobUrlParts\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobUrlParts\"></xref> object containing all the components of a BlobURL."
type: "<xref href=\"com.azure.storage.blob.BlobUrlParts?alt=com.azure.storage.blob.BlobUrlParts&text=BlobUrlParts\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.BlobUrlParts.parseSasQueryParameters(java.lang.String)"
fullName: "com.azure.storage.blob.BlobUrlParts.parseSasQueryParameters(String queryParams)"
name: "parseSasQueryParameters(String queryParams)"
nameWithType: "BlobUrlParts.parseSasQueryParameters(String queryParams)"
summary: "Sets the <xref uid=\"com.azure.storage.common.sas.CommonSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CommonSasQueryParameters\"></xref> representing the SAS query parameters that will be used to generate the SAS token for this URL."
parameters:
- description: "The SAS query parameter string."
name: "queryParams"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobUrlParts parseSasQueryParameters(String queryParams)"
desc: "Sets the <xref uid=\"com.azure.storage.common.sas.CommonSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CommonSasQueryParameters\"></xref> representing the SAS query parameters that will be used to generate the SAS token for this URL."
returns:
description: "the updated BlobUrlParts object."
type: "<xref href=\"com.azure.storage.blob.BlobUrlParts?alt=com.azure.storage.blob.BlobUrlParts&text=BlobUrlParts\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.BlobUrlParts.setAccountName(java.lang.String)"
fullName: "com.azure.storage.blob.BlobUrlParts.setAccountName(String accountName)"
name: "setAccountName(String accountName)"
nameWithType: "BlobUrlParts.setAccountName(String accountName)"
summary: "Sets the account name."
parameters:
- description: "The account name."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobUrlParts setAccountName(String accountName)"
desc: "Sets the account name."
returns:
description: "the updated BlobURLParts object."
type: "<xref href=\"com.azure.storage.blob.BlobUrlParts?alt=com.azure.storage.blob.BlobUrlParts&text=BlobUrlParts\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.BlobUrlParts.setBlobName(java.lang.String)"
fullName: "com.azure.storage.blob.BlobUrlParts.setBlobName(String blobName)"
name: "setBlobName(String blobName)"
nameWithType: "BlobUrlParts.setBlobName(String blobName)"
summary: "Sets the blob name that will be used as part of the URL path."
parameters:
- description: "The blob name. If the blob name contains special characters, pass in the url encoded version\n of the blob name."
name: "blobName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobUrlParts setBlobName(String blobName)"
desc: "Sets the blob name that will be used as part of the URL path."
returns:
description: "the updated BlobUrlParts object."
type: "<xref href=\"com.azure.storage.blob.BlobUrlParts?alt=com.azure.storage.blob.BlobUrlParts&text=BlobUrlParts\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.BlobUrlParts.setCommonSasQueryParameters(com.azure.storage.common.sas.CommonSasQueryParameters)"
fullName: "com.azure.storage.blob.BlobUrlParts.setCommonSasQueryParameters(CommonSasQueryParameters commonSasQueryParameters)"
name: "setCommonSasQueryParameters(CommonSasQueryParameters commonSasQueryParameters)"
nameWithType: "BlobUrlParts.setCommonSasQueryParameters(CommonSasQueryParameters commonSasQueryParameters)"
summary: "Sets the <xref uid=\"com.azure.storage.common.sas.CommonSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CommonSasQueryParameters\"></xref> representing the SAS query parameters that will be used to generate the SAS token for this URL."
parameters:
- description: "The SAS query parameters."
name: "commonSasQueryParameters"
type: "<xref href=\"com.azure.storage.common.sas.CommonSasQueryParameters?alt=com.azure.storage.common.sas.CommonSasQueryParameters&text=CommonSasQueryParameters\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BlobUrlParts setCommonSasQueryParameters(CommonSasQueryParameters commonSasQueryParameters)"
desc: "Sets the <xref uid=\"com.azure.storage.common.sas.CommonSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CommonSasQueryParameters\"></xref> representing the SAS query parameters that will be used to generate the SAS token for this URL."
returns:
description: "the updated BlobUrlParts object."
type: "<xref href=\"com.azure.storage.blob.BlobUrlParts?alt=com.azure.storage.blob.BlobUrlParts&text=BlobUrlParts\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.BlobUrlParts.setContainerName(java.lang.String)"
fullName: "com.azure.storage.blob.BlobUrlParts.setContainerName(String containerName)"
name: "setContainerName(String containerName)"
nameWithType: "BlobUrlParts.setContainerName(String containerName)"
summary: "Sets the container name that will be used as part of the URL path."
parameters:
- description: "The container nme."
name: "containerName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobUrlParts setContainerName(String containerName)"
desc: "Sets the container name that will be used as part of the URL path."
returns:
description: "the updated BlobUrlParts object."
type: "<xref href=\"com.azure.storage.blob.BlobUrlParts?alt=com.azure.storage.blob.BlobUrlParts&text=BlobUrlParts\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.BlobUrlParts.setHost(java.lang.String)"
fullName: "com.azure.storage.blob.BlobUrlParts.setHost(String host)"
name: "setHost(String host)"
nameWithType: "BlobUrlParts.setHost(String host)"
summary: "Sets the URL host, ex."
parameters:
- description: "The URL host."
name: "host"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobUrlParts setHost(String host)"
desc: "Sets the URL host, ex. \"account.blob.core.windows.net\" or \"127.0.0.1:10000\"."
returns:
description: "the updated BlobUrlParts object."
type: "<xref href=\"com.azure.storage.blob.BlobUrlParts?alt=com.azure.storage.blob.BlobUrlParts&text=BlobUrlParts\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.BlobUrlParts.setSasQueryParameters(com.azure.storage.blob.sas.BlobServiceSasQueryParameters)"
fullName: "com.azure.storage.blob.BlobUrlParts.setSasQueryParameters(BlobServiceSasQueryParameters blobServiceSasQueryParameters)"
name: "setSasQueryParameters(BlobServiceSasQueryParameters blobServiceSasQueryParameters)"
nameWithType: "BlobUrlParts.setSasQueryParameters(BlobServiceSasQueryParameters blobServiceSasQueryParameters)"
summary: "Sets the <xref uid=\"com.azure.storage.blob.sas.BlobServiceSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobServiceSasQueryParameters\"></xref> representing the SAS query parameters."
deprecatedTag: "Please use <xref uid=\"com.azure.storage.blob.BlobUrlParts.setCommonSasQueryParameters(com.azure.storage.common.sas.CommonSasQueryParameters)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#setCommonSasQueryParameters(CommonSasQueryParameters)\"></xref>"
parameters:
- description: "The SAS query parameters."
name: "blobServiceSasQueryParameters"
type: "<xref href=\"com.azure.storage.blob.sas.BlobServiceSasQueryParameters?alt=com.azure.storage.blob.sas.BlobServiceSasQueryParameters&text=BlobServiceSasQueryParameters\" 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 BlobUrlParts setSasQueryParameters(BlobServiceSasQueryParameters blobServiceSasQueryParameters)"
desc: "Sets the <xref uid=\"com.azure.storage.blob.sas.BlobServiceSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobServiceSasQueryParameters\"></xref> representing the SAS query parameters."
hasDeprecatedTag: true
returns:
description: "the updated BlobUrlParts object."
type: "<xref href=\"com.azure.storage.blob.BlobUrlParts?alt=com.azure.storage.blob.BlobUrlParts&text=BlobUrlParts\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.BlobUrlParts.setScheme(java.lang.String)"
fullName: "com.azure.storage.blob.BlobUrlParts.setScheme(String scheme)"
name: "setScheme(String scheme)"
nameWithType: "BlobUrlParts.setScheme(String scheme)"
summary: "Sets the URL scheme, ex."
parameters:
- description: "The URL scheme."
name: "scheme"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobUrlParts setScheme(String scheme)"
desc: "Sets the URL scheme, ex. \"https\"."
returns:
description: "the updated BlobUrlParts object."
type: "<xref href=\"com.azure.storage.blob.BlobUrlParts?alt=com.azure.storage.blob.BlobUrlParts&text=BlobUrlParts\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.BlobUrlParts.setSnapshot(java.lang.String)"
fullName: "com.azure.storage.blob.BlobUrlParts.setSnapshot(String snapshot)"
name: "setSnapshot(String snapshot)"
nameWithType: "BlobUrlParts.setSnapshot(String snapshot)"
summary: "Sets the snapshot identifier that will be used as part of the query string if set."
parameters:
- description: "The snapshot identifier."
name: "snapshot"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobUrlParts setSnapshot(String snapshot)"
desc: "Sets the snapshot identifier that will be used as part of the query string if set."
returns:
description: "the updated BlobUrlParts object."
type: "<xref href=\"com.azure.storage.blob.BlobUrlParts?alt=com.azure.storage.blob.BlobUrlParts&text=BlobUrlParts\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.BlobUrlParts.setUnparsedParameters(java.util.Map<java.lang.String,java.lang.String[]>)"
fullName: "com.azure.storage.blob.BlobUrlParts.setUnparsedParameters(Map<String,String[]> unparsedParameters)"
name: "setUnparsedParameters(Map<String,String[]> unparsedParameters)"
nameWithType: "BlobUrlParts.setUnparsedParameters(Map<String,String[]> unparsedParameters)"
summary: "Sets the query string parameters that aren't part of the SAS token that will be used by this URL."
parameters:
- description: "The non-SAS token query string values."
name: "unparsedParameters"
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>[]>"
syntax: "public BlobUrlParts setUnparsedParameters(Map<String,String[]> unparsedParameters)"
desc: "Sets the query string parameters that aren't part of the SAS token that will be used by this URL."
returns:
description: "the updated BlobUrlParts object."
type: "<xref href=\"com.azure.storage.blob.BlobUrlParts?alt=com.azure.storage.blob.BlobUrlParts&text=BlobUrlParts\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.BlobUrlParts.setVersionId(java.lang.String)"
fullName: "com.azure.storage.blob.BlobUrlParts.setVersionId(String versionId)"
name: "setVersionId(String versionId)"
nameWithType: "BlobUrlParts.setVersionId(String versionId)"
summary: "Sets the version identifier that will be used as part of the query string if set."
parameters:
- description: "The version identifier."
name: "versionId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobUrlParts setVersionId(String versionId)"
desc: "Sets the version identifier that will be used as part of the query string if set."
returns:
description: "the updated BlobUrlParts object."
type: "<xref href=\"com.azure.storage.blob.BlobUrlParts?alt=com.azure.storage.blob.BlobUrlParts&text=BlobUrlParts\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.BlobUrlParts.toUrl()"
fullName: "com.azure.storage.blob.BlobUrlParts.toUrl()"
name: "toUrl()"
nameWithType: "BlobUrlParts.toUrl()"
summary: "Converts the blob URL parts to a <xref uid=\"java.net.URL\" data-throw-if-not-resolved=\"false\" data-raw-source=\"URL\"></xref>."
syntax: "public URL toUrl()"
desc: "Converts the blob URL parts to a <xref uid=\"java.net.URL\" data-throw-if-not-resolved=\"false\" data-raw-source=\"URL\"></xref>."
returns:
description: "A <code>URL</code> to the blob resource composed of all the elements in this object."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/net/URL.html\">URL</a>"
type: "class"
desc: "This class represents the components that make up an Azure Storage Container/Blob URL. You may parse an existing URL into its parts with the <xref uid=\"com.azure.storage.blob.BlobUrlParts.parse(java.net.URL)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#parse(URL)\"></xref> class. You may construct a URL from parts by calling <xref uid=\"com.azure.storage.blob.BlobUrlParts.toUrl()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#toUrl()\"></xref>."
metadata: {}
package: "com.azure.storage.blob"
artifact: com.azure:azure-storage-blob:12.26.1