-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.azure.storage.file.datalake.models.FileReadHeaders.yml
827 lines (827 loc) · 68.5 KB
/
com.azure.storage.file.datalake.models.FileReadHeaders.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
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
### YamlMime:JavaType
uid: "com.azure.storage.file.datalake.models.FileReadHeaders"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders"
name: "FileReadHeaders"
nameWithType: "FileReadHeaders"
summary: "Defines headers for Read operation."
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 **FileReadHeaders**"
constructors:
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.FileReadHeaders()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.FileReadHeaders()"
name: "FileReadHeaders()"
nameWithType: "FileReadHeaders.FileReadHeaders()"
syntax: "public FileReadHeaders()"
methods:
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getAcceptRanges()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getAcceptRanges()"
name: "getAcceptRanges()"
nameWithType: "FileReadHeaders.getAcceptRanges()"
summary: "Get the accept<wbr>Ranges property: Indicates that the service supports requests for partial file content."
syntax: "public String getAcceptRanges()"
desc: "Get the acceptRanges property: Indicates that the service supports requests for partial file content."
returns:
description: "the acceptRanges value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getAccessControlList()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getAccessControlList()"
name: "getAccessControlList()"
nameWithType: "FileReadHeaders.getAccessControlList()"
summary: "Optional."
syntax: "public List<PathAccessControlEntry> getAccessControlList()"
desc: "Optional. The POSIX access control list for the file or directory."
returns:
description: "the access control list."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.storage.file.datalake.models.PathAccessControlEntry?alt=com.azure.storage.file.datalake.models.PathAccessControlEntry&text=PathAccessControlEntry\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getCacheControl()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getCacheControl()"
name: "getCacheControl()"
nameWithType: "FileReadHeaders.getCacheControl()"
summary: "Get the cache<wbr>Control property: This header is returned if it was previously specified for the file."
syntax: "public String getCacheControl()"
desc: "Get the cacheControl property: This header is returned if it was previously specified for the file."
returns:
description: "the cacheControl value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getClientRequestId()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getClientRequestId()"
name: "getClientRequestId()"
nameWithType: "FileReadHeaders.getClientRequestId()"
summary: "Get the client<wbr>Request<wbr>Id property: If a client request id header is sent in the request, this header will be present in the response with the same value."
syntax: "public String getClientRequestId()"
desc: "Get the clientRequestId property: If a client request id header is sent in the request, this header will be present in the response with the same value."
returns:
description: "the clientRequestId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getContentCrc64()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getContentCrc64()"
name: "getContentCrc64()"
nameWithType: "FileReadHeaders.getContentCrc64()"
summary: "Get the content<wbr>Crc64 property: If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB."
syntax: "public byte[] getContentCrc64()"
desc: "Get the contentCrc64 property: If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request)."
returns:
description: "the contentCrc64 value."
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getContentDisposition()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getContentDisposition()"
name: "getContentDisposition()"
nameWithType: "FileReadHeaders.getContentDisposition()"
summary: "Get the content<wbr>Disposition property: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header."
syntax: "public String getContentDisposition()"
desc: "Get the contentDisposition property: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the file name specified."
returns:
description: "the contentDisposition value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getContentEncoding()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getContentEncoding()"
name: "getContentEncoding()"
nameWithType: "FileReadHeaders.getContentEncoding()"
summary: "Get the content<wbr>Encoding property: This header returns the value that was specified for the Content-Encoding request header."
syntax: "public String getContentEncoding()"
desc: "Get the contentEncoding property: This header returns the value that was specified for the Content-Encoding request header."
returns:
description: "the contentEncoding value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getContentLanguage()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getContentLanguage()"
name: "getContentLanguage()"
nameWithType: "FileReadHeaders.getContentLanguage()"
summary: "Get the content<wbr>Language property: This header returns the value that was specified for the Content-Language request header."
syntax: "public String getContentLanguage()"
desc: "Get the contentLanguage property: This header returns the value that was specified for the Content-Language request header."
returns:
description: "the contentLanguage value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getContentLength()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getContentLength()"
name: "getContentLength()"
nameWithType: "FileReadHeaders.getContentLength()"
summary: "Get the content<wbr>Length property: The number of bytes present in the response body."
syntax: "public Long getContentLength()"
desc: "Get the contentLength property: The number of bytes present in the response body."
returns:
description: "the contentLength value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getContentMd5()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getContentMd5()"
name: "getContentMd5()"
nameWithType: "FileReadHeaders.getContentMd5()"
summary: "Get the content<wbr>Md5 property: If the file has an MD5 hash and this operation is to read the full file, this response header is returned so that the client can check for message content integrity."
syntax: "public byte[] getContentMd5()"
desc: "Get the contentMd5 property: If the file has an MD5 hash and this operation is to read the full file, this response header is returned so that the client can check for message content integrity."
returns:
description: "the contentMd5 value."
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getContentRange()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getContentRange()"
name: "getContentRange()"
nameWithType: "FileReadHeaders.getContentRange()"
summary: "Get the content<wbr>Range property: Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the 'Range' request header."
syntax: "public String getContentRange()"
desc: "Get the contentRange property: Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the 'Range' request header."
returns:
description: "the contentRange value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getContentType()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getContentType()"
name: "getContentType()"
nameWithType: "FileReadHeaders.getContentType()"
summary: "Get the content<wbr>Type property: The media type of the body of the response."
syntax: "public String getContentType()"
desc: "Get the contentType property: The media type of the body of the response. For Download Blob this is 'application/octet-stream'."
returns:
description: "the contentType value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getCopyCompletionTime()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getCopyCompletionTime()"
name: "getCopyCompletionTime()"
nameWithType: "FileReadHeaders.getCopyCompletionTime()"
summary: "Get the copy<wbr>Completion<wbr>Time property: Conclusion time of the last attempted Copy Blob operation where this file was the destination file."
syntax: "public OffsetDateTime getCopyCompletionTime()"
desc: "Get the copyCompletionTime property: Conclusion time of the last attempted Copy Blob operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this file has never been the destination in a Copy Blob operation, or if this file has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
returns:
description: "the copyCompletionTime value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getCopyId()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getCopyId()"
name: "getCopyId()"
nameWithType: "FileReadHeaders.getCopyId()"
summary: "Get the copy<wbr>Id property: String identifier for this copy operation."
syntax: "public String getCopyId()"
desc: "Get the copyId property: String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy."
returns:
description: "the copyId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getCopyProgress()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getCopyProgress()"
name: "getCopyProgress()"
nameWithType: "FileReadHeaders.getCopyProgress()"
summary: "Get the copy<wbr>Progress property: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this file was the destination file."
syntax: "public String getCopyProgress()"
desc: "Get the copyProgress property: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this file was the destination file. Can show between 0 and Content-Length bytes copied. This header does not appear if this file has never been the destination in a Copy Blob operation, or if this file has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
returns:
description: "the copyProgress value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getCopySource()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getCopySource()"
name: "getCopySource()"
nameWithType: "FileReadHeaders.getCopySource()"
summary: "Get the copy<wbr>Source property: URL up to 2 KB in length that specifies the source file or file used in the last attempted Copy Blob operation where this file was the destination file."
syntax: "public String getCopySource()"
desc: "Get the copySource property: URL up to 2 KB in length that specifies the source file or file used in the last attempted Copy Blob operation where this file was the destination file. This header does not appear if this file has never been the destination in a Copy Blob operation, or if this file has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
returns:
description: "the copySource value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getCopyStatus()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getCopyStatus()"
name: "getCopyStatus()"
nameWithType: "FileReadHeaders.getCopyStatus()"
summary: "Get the copy<wbr>Status property: State of the copy operation identified by x-ms-copy-id."
syntax: "public CopyStatusType getCopyStatus()"
desc: "Get the copyStatus property: State of the copy operation identified by x-ms-copy-id. Possible values include: 'pending', 'success', 'aborted', 'failed'."
returns:
description: "the copyStatus value."
type: "<xref href=\"com.azure.storage.file.datalake.models.CopyStatusType?alt=com.azure.storage.file.datalake.models.CopyStatusType&text=CopyStatusType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getCopyStatusDescription()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getCopyStatusDescription()"
name: "getCopyStatusDescription()"
nameWithType: "FileReadHeaders.getCopyStatusDescription()"
summary: "Get the copy<wbr>Status<wbr>Description property: Only appears when x-ms-copy-status is failed or pending."
syntax: "public String getCopyStatusDescription()"
desc: "Get the copyStatusDescription property: Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this file has never been the destination in a Copy Blob operation, or if this file has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
returns:
description: "the copyStatusDescription value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getCreationTime()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getCreationTime()"
name: "getCreationTime()"
nameWithType: "FileReadHeaders.getCreationTime()"
summary: "Get the creation<wbr>Time property: The x-ms-creation-time property."
syntax: "public OffsetDateTime getCreationTime()"
desc: "Get the creationTime property: The x-ms-creation-time property."
returns:
description: "the creationTime value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getDateProperty()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getDateProperty()"
name: "getDateProperty()"
nameWithType: "FileReadHeaders.getDateProperty()"
summary: "Get the date<wbr>Property property: UTC date/time value generated by the service that indicates the time at which the response was initiated."
syntax: "public OffsetDateTime getDateProperty()"
desc: "Get the dateProperty property: UTC date/time value generated by the service that indicates the time at which the response was initiated."
returns:
description: "the dateProperty value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getETag()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getETag()"
name: "getETag()"
nameWithType: "FileReadHeaders.getETag()"
summary: "Get the e<wbr>Tag property: The ETag contains a value that you can use to perform operations conditionally."
syntax: "public String getETag()"
desc: "Get the eTag property: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
returns:
description: "the eTag value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getEncryptionContext()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getEncryptionContext()"
name: "getEncryptionContext()"
nameWithType: "FileReadHeaders.getEncryptionContext()"
summary: "Get the encryption<wbr>Context property: Encryption context for this path."
syntax: "public String getEncryptionContext()"
desc: "Get the encryptionContext property: Encryption context for this path."
returns:
description: "the encryptionContext value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getEncryptionKeySha256()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getEncryptionKeySha256()"
name: "getEncryptionKeySha256()"
nameWithType: "FileReadHeaders.getEncryptionKeySha256()"
summary: "Get the encryption<wbr>Key<wbr>Sha256 property: The SHA-256 hash of the encryption key used to encrypt the file."
syntax: "public String getEncryptionKeySha256()"
desc: "Get the encryptionKeySha256 property: The SHA-256 hash of the encryption key used to encrypt the file. This header is only returned when the file was encrypted with a customer-provided key."
returns:
description: "the encryptionKeySha256 value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getErrorCode()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getErrorCode()"
name: "getErrorCode()"
nameWithType: "FileReadHeaders.getErrorCode()"
summary: "Get the error<wbr>Code property: The error<wbr>Code property."
syntax: "public String getErrorCode()"
desc: "Get the errorCode property: The errorCode property."
returns:
description: "the errorCode value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getFileContentMd5()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getFileContentMd5()"
name: "getFileContentMd5()"
nameWithType: "FileReadHeaders.getFileContentMd5()"
summary: "Get the file<wbr>ContentMD5 property: If the file has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value."
syntax: "public byte[] getFileContentMd5()"
desc: "Get the fileContentMD5 property: If the file has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range."
returns:
description: "the fileContentMD5 value."
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getLastModified()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getLastModified()"
name: "getLastModified()"
nameWithType: "FileReadHeaders.getLastModified()"
summary: "Get the last<wbr>Modified property: Returns the date and time the container was last modified."
syntax: "public OffsetDateTime getLastModified()"
desc: "Get the lastModified property: Returns the date and time the container was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file."
returns:
description: "the lastModified value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getLeaseDuration()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getLeaseDuration()"
name: "getLeaseDuration()"
nameWithType: "FileReadHeaders.getLeaseDuration()"
summary: "Get the lease<wbr>Duration property: When a file is leased, specifies whether the lease is of infinite or fixed duration."
syntax: "public LeaseDurationType getLeaseDuration()"
desc: "Get the leaseDuration property: When a file is leased, specifies whether the lease is of infinite or fixed duration. Possible values include: 'infinite', 'fixed'."
returns:
description: "the leaseDuration value."
type: "<xref href=\"com.azure.storage.file.datalake.models.LeaseDurationType?alt=com.azure.storage.file.datalake.models.LeaseDurationType&text=LeaseDurationType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getLeaseState()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getLeaseState()"
name: "getLeaseState()"
nameWithType: "FileReadHeaders.getLeaseState()"
summary: "Get the lease<wbr>State property: Lease state of the file."
syntax: "public LeaseStateType getLeaseState()"
desc: "Get the leaseState property: Lease state of the file. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'."
returns:
description: "the leaseState value."
type: "<xref href=\"com.azure.storage.file.datalake.models.LeaseStateType?alt=com.azure.storage.file.datalake.models.LeaseStateType&text=LeaseStateType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getLeaseStatus()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getLeaseStatus()"
name: "getLeaseStatus()"
nameWithType: "FileReadHeaders.getLeaseStatus()"
summary: "Get the lease<wbr>Status property: The current lease status of the file."
syntax: "public LeaseStatusType getLeaseStatus()"
desc: "Get the leaseStatus property: The current lease status of the file. Possible values include: 'locked', 'unlocked'."
returns:
description: "the leaseStatus value."
type: "<xref href=\"com.azure.storage.file.datalake.models.LeaseStatusType?alt=com.azure.storage.file.datalake.models.LeaseStatusType&text=LeaseStatusType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getMetadata()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getMetadata()"
name: "getMetadata()"
nameWithType: "FileReadHeaders.getMetadata()"
summary: "Get the metadata property: The metadata property."
syntax: "public Map<String,String> getMetadata()"
desc: "Get the metadata property: The metadata property."
returns:
description: "the metadata value."
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.file.datalake.models.FileReadHeaders.getRequestId()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getRequestId()"
name: "getRequestId()"
nameWithType: "FileReadHeaders.getRequestId()"
summary: "Get the request<wbr>Id property: This header uniquely identifies the request that was made and can be used for troubleshooting the request."
syntax: "public String getRequestId()"
desc: "Get the requestId property: This header uniquely identifies the request that was made and can be used for troubleshooting the request."
returns:
description: "the requestId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.getVersion()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.getVersion()"
name: "getVersion()"
nameWithType: "FileReadHeaders.getVersion()"
summary: "Get the version property: Indicates the version of the Blob service used to execute the request."
syntax: "public String getVersion()"
desc: "Get the version property: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
returns:
description: "the version value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.isServerEncrypted()"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.isServerEncrypted()"
name: "isServerEncrypted()"
nameWithType: "FileReadHeaders.isServerEncrypted()"
summary: "Get the is<wbr>Server<wbr>Encrypted property: The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm."
syntax: "public Boolean isServerEncrypted()"
desc: "Get the isServerEncrypted property: The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted)."
returns:
description: "the isServerEncrypted value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setAcceptRanges(java.lang.String)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setAcceptRanges(String acceptRanges)"
name: "setAcceptRanges(String acceptRanges)"
nameWithType: "FileReadHeaders.setAcceptRanges(String acceptRanges)"
summary: "Set the accept<wbr>Ranges property: Indicates that the service supports requests for partial file content."
parameters:
- description: "the acceptRanges value to set."
name: "acceptRanges"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileReadHeaders setAcceptRanges(String acceptRanges)"
desc: "Set the acceptRanges property: Indicates that the service supports requests for partial file content."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setAccessControlList(java.util.List<com.azure.storage.file.datalake.models.PathAccessControlEntry>)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setAccessControlList(List<PathAccessControlEntry> accessControlList)"
name: "setAccessControlList(List<PathAccessControlEntry> accessControlList)"
nameWithType: "FileReadHeaders.setAccessControlList(List<PathAccessControlEntry> accessControlList)"
summary: "Optional."
parameters:
- description: "the access control list to be set on the file or directory."
name: "accessControlList"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.storage.file.datalake.models.PathAccessControlEntry?alt=com.azure.storage.file.datalake.models.PathAccessControlEntry&text=PathAccessControlEntry\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public FileReadHeaders setAccessControlList(List<PathAccessControlEntry> accessControlList)"
desc: "Optional. The POSIX access control list for the file or directory."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setCacheControl(java.lang.String)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setCacheControl(String cacheControl)"
name: "setCacheControl(String cacheControl)"
nameWithType: "FileReadHeaders.setCacheControl(String cacheControl)"
summary: "Set the cache<wbr>Control property: This header is returned if it was previously specified for the file."
parameters:
- description: "the cacheControl value to set."
name: "cacheControl"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileReadHeaders setCacheControl(String cacheControl)"
desc: "Set the cacheControl property: This header is returned if it was previously specified for the file."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setClientRequestId(java.lang.String)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setClientRequestId(String clientRequestId)"
name: "setClientRequestId(String clientRequestId)"
nameWithType: "FileReadHeaders.setClientRequestId(String clientRequestId)"
summary: "Set the client<wbr>Request<wbr>Id property: If a client request id header is sent in the request, this header will be present in the response with the same value."
parameters:
- description: "the clientRequestId value to set."
name: "clientRequestId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileReadHeaders setClientRequestId(String clientRequestId)"
desc: "Set the clientRequestId property: If a client request id header is sent in the request, this header will be present in the response with the same value."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setContentCrc64(byte[])"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setContentCrc64(byte[] contentCrc64)"
name: "setContentCrc64(byte[] contentCrc64)"
nameWithType: "FileReadHeaders.setContentCrc64(byte[] contentCrc64)"
summary: "Set the content<wbr>Crc64 property: If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB."
parameters:
- description: "the contentCrc64 value to set."
name: "contentCrc64"
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
syntax: "public FileReadHeaders setContentCrc64(byte[] contentCrc64)"
desc: "Set the contentCrc64 property: If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request)."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setContentDisposition(java.lang.String)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setContentDisposition(String contentDisposition)"
name: "setContentDisposition(String contentDisposition)"
nameWithType: "FileReadHeaders.setContentDisposition(String contentDisposition)"
summary: "Set the content<wbr>Disposition property: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header."
parameters:
- description: "the contentDisposition value to set."
name: "contentDisposition"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileReadHeaders setContentDisposition(String contentDisposition)"
desc: "Set the contentDisposition property: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the file name specified."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setContentEncoding(java.lang.String)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setContentEncoding(String contentEncoding)"
name: "setContentEncoding(String contentEncoding)"
nameWithType: "FileReadHeaders.setContentEncoding(String contentEncoding)"
summary: "Set the content<wbr>Encoding property: This header returns the value that was specified for the Content-Encoding request header."
parameters:
- description: "the contentEncoding value to set."
name: "contentEncoding"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileReadHeaders setContentEncoding(String contentEncoding)"
desc: "Set the contentEncoding property: This header returns the value that was specified for the Content-Encoding request header."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setContentLanguage(java.lang.String)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setContentLanguage(String contentLanguage)"
name: "setContentLanguage(String contentLanguage)"
nameWithType: "FileReadHeaders.setContentLanguage(String contentLanguage)"
summary: "Set the content<wbr>Language property: This header returns the value that was specified for the Content-Language request header."
parameters:
- description: "the contentLanguage value to set."
name: "contentLanguage"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileReadHeaders setContentLanguage(String contentLanguage)"
desc: "Set the contentLanguage property: This header returns the value that was specified for the Content-Language request header."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setContentLength(java.lang.Long)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setContentLength(Long contentLength)"
name: "setContentLength(Long contentLength)"
nameWithType: "FileReadHeaders.setContentLength(Long contentLength)"
summary: "Set the content<wbr>Length property: The number of bytes present in the response body."
parameters:
- description: "the contentLength value to set."
name: "contentLength"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
syntax: "public FileReadHeaders setContentLength(Long contentLength)"
desc: "Set the contentLength property: The number of bytes present in the response body."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setContentMd5(byte[])"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setContentMd5(byte[] contentMd5)"
name: "setContentMd5(byte[] contentMd5)"
nameWithType: "FileReadHeaders.setContentMd5(byte[] contentMd5)"
summary: "Set the content<wbr>Md5 property: If the file has an MD5 hash and this operation is to read the full file, this response header is returned so that the client can check for message content integrity."
parameters:
- description: "the contentMd5 value to set."
name: "contentMd5"
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
syntax: "public FileReadHeaders setContentMd5(byte[] contentMd5)"
desc: "Set the contentMd5 property: If the file has an MD5 hash and this operation is to read the full file, this response header is returned so that the client can check for message content integrity."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setContentRange(java.lang.String)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setContentRange(String contentRange)"
name: "setContentRange(String contentRange)"
nameWithType: "FileReadHeaders.setContentRange(String contentRange)"
summary: "Set the content<wbr>Range property: Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the 'Range' request header."
parameters:
- description: "the contentRange value to set."
name: "contentRange"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileReadHeaders setContentRange(String contentRange)"
desc: "Set the contentRange property: Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the 'Range' request header."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setContentType(java.lang.String)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setContentType(String contentType)"
name: "setContentType(String contentType)"
nameWithType: "FileReadHeaders.setContentType(String contentType)"
summary: "Set the content<wbr>Type property: The media type of the body of the response."
parameters:
- description: "the contentType value to set."
name: "contentType"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileReadHeaders setContentType(String contentType)"
desc: "Set the contentType property: The media type of the body of the response. For Download Blob this is 'application/octet-stream'."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setCopyCompletionTime(java.time.OffsetDateTime)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setCopyCompletionTime(OffsetDateTime copyCompletionTime)"
name: "setCopyCompletionTime(OffsetDateTime copyCompletionTime)"
nameWithType: "FileReadHeaders.setCopyCompletionTime(OffsetDateTime copyCompletionTime)"
summary: "Set the copy<wbr>Completion<wbr>Time property: Conclusion time of the last attempted Copy Blob operation where this file was the destination file."
parameters:
- description: "the copyCompletionTime value to set."
name: "copyCompletionTime"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
syntax: "public FileReadHeaders setCopyCompletionTime(OffsetDateTime copyCompletionTime)"
desc: "Set the copyCompletionTime property: Conclusion time of the last attempted Copy Blob operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this file has never been the destination in a Copy Blob operation, or if this file has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setCopyId(java.lang.String)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setCopyId(String copyId)"
name: "setCopyId(String copyId)"
nameWithType: "FileReadHeaders.setCopyId(String copyId)"
summary: "Set the copy<wbr>Id property: String identifier for this copy operation."
parameters:
- description: "the copyId value to set."
name: "copyId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileReadHeaders setCopyId(String copyId)"
desc: "Set the copyId property: String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setCopyProgress(java.lang.String)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setCopyProgress(String copyProgress)"
name: "setCopyProgress(String copyProgress)"
nameWithType: "FileReadHeaders.setCopyProgress(String copyProgress)"
summary: "Set the copy<wbr>Progress property: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this file was the destination file."
parameters:
- description: "the copyProgress value to set."
name: "copyProgress"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileReadHeaders setCopyProgress(String copyProgress)"
desc: "Set the copyProgress property: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this file was the destination file. Can show between 0 and Content-Length bytes copied. This header does not appear if this file has never been the destination in a Copy Blob operation, or if this file has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setCopySource(java.lang.String)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setCopySource(String copySource)"
name: "setCopySource(String copySource)"
nameWithType: "FileReadHeaders.setCopySource(String copySource)"
summary: "Set the copy<wbr>Source property: URL up to 2 KB in length that specifies the source file or file used in the last attempted Copy Blob operation where this file was the destination file."
parameters:
- description: "the copySource value to set."
name: "copySource"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileReadHeaders setCopySource(String copySource)"
desc: "Set the copySource property: URL up to 2 KB in length that specifies the source file or file used in the last attempted Copy Blob operation where this file was the destination file. This header does not appear if this file has never been the destination in a Copy Blob operation, or if this file has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setCopyStatus(com.azure.storage.file.datalake.models.CopyStatusType)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setCopyStatus(CopyStatusType copyStatus)"
name: "setCopyStatus(CopyStatusType copyStatus)"
nameWithType: "FileReadHeaders.setCopyStatus(CopyStatusType copyStatus)"
summary: "Set the copy<wbr>Status property: State of the copy operation identified by x-ms-copy-id."
parameters:
- description: "the copyStatus value to set."
name: "copyStatus"
type: "<xref href=\"com.azure.storage.file.datalake.models.CopyStatusType?alt=com.azure.storage.file.datalake.models.CopyStatusType&text=CopyStatusType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FileReadHeaders setCopyStatus(CopyStatusType copyStatus)"
desc: "Set the copyStatus property: State of the copy operation identified by x-ms-copy-id. Possible values include: 'pending', 'success', 'aborted', 'failed'."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setCopyStatusDescription(java.lang.String)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setCopyStatusDescription(String copyStatusDescription)"
name: "setCopyStatusDescription(String copyStatusDescription)"
nameWithType: "FileReadHeaders.setCopyStatusDescription(String copyStatusDescription)"
summary: "Set the copy<wbr>Status<wbr>Description property: Only appears when x-ms-copy-status is failed or pending."
parameters:
- description: "the copyStatusDescription value to set."
name: "copyStatusDescription"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileReadHeaders setCopyStatusDescription(String copyStatusDescription)"
desc: "Set the copyStatusDescription property: Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this file has never been the destination in a Copy Blob operation, or if this file has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setCreationTime(java.time.OffsetDateTime)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setCreationTime(OffsetDateTime creationTime)"
name: "setCreationTime(OffsetDateTime creationTime)"
nameWithType: "FileReadHeaders.setCreationTime(OffsetDateTime creationTime)"
summary: "Set the creation<wbr>Time property: The x-ms-creation-time property."
parameters:
- description: "the creation time value to set."
name: "creationTime"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
syntax: "public FileReadHeaders setCreationTime(OffsetDateTime creationTime)"
desc: "Set the creationTime property: The x-ms-creation-time property."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setDateProperty(java.time.OffsetDateTime)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setDateProperty(OffsetDateTime dateProperty)"
name: "setDateProperty(OffsetDateTime dateProperty)"
nameWithType: "FileReadHeaders.setDateProperty(OffsetDateTime dateProperty)"
summary: "Set the date<wbr>Property property: UTC date/time value generated by the service that indicates the time at which the response was initiated."
parameters:
- description: "the dateProperty value to set."
name: "dateProperty"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
syntax: "public FileReadHeaders setDateProperty(OffsetDateTime dateProperty)"
desc: "Set the dateProperty property: UTC date/time value generated by the service that indicates the time at which the response was initiated."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setETag(java.lang.String)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setETag(String eTag)"
name: "setETag(String eTag)"
nameWithType: "FileReadHeaders.setETag(String eTag)"
summary: "Set the e<wbr>Tag property: The ETag contains a value that you can use to perform operations conditionally."
parameters:
- description: "the eTag value to set."
name: "eTag"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileReadHeaders setETag(String eTag)"
desc: "Set the eTag property: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setEncryptionContext(java.lang.String)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setEncryptionContext(String encryptionContext)"
name: "setEncryptionContext(String encryptionContext)"
nameWithType: "FileReadHeaders.setEncryptionContext(String encryptionContext)"
summary: "Encryption context that can be set on the file."
parameters:
- description: "the encryption context to be set on the file."
name: "encryptionContext"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileReadHeaders setEncryptionContext(String encryptionContext)"
desc: "Encryption context that can be set on the file. Encryption context is intended to store metadata that can be used to decrypt the blob."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setEncryptionKeySha256(java.lang.String)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setEncryptionKeySha256(String encryptionKeySha256)"
name: "setEncryptionKeySha256(String encryptionKeySha256)"
nameWithType: "FileReadHeaders.setEncryptionKeySha256(String encryptionKeySha256)"
summary: "Set the encryption<wbr>Key<wbr>Sha256 property: The SHA-256 hash of the encryption key used to encrypt the file."
parameters:
- description: "the encryptionKeySha256 value to set."
name: "encryptionKeySha256"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileReadHeaders setEncryptionKeySha256(String encryptionKeySha256)"
desc: "Set the encryptionKeySha256 property: The SHA-256 hash of the encryption key used to encrypt the file. This header is only returned when the file was encrypted with a customer-provided key."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setErrorCode(java.lang.String)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setErrorCode(String errorCode)"
name: "setErrorCode(String errorCode)"
nameWithType: "FileReadHeaders.setErrorCode(String errorCode)"
summary: "Set the error<wbr>Code property: The error<wbr>Code property."
parameters:
- description: "the errorCode value to set."
name: "errorCode"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileReadHeaders setErrorCode(String errorCode)"
desc: "Set the errorCode property: The errorCode property."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setFileContentMd5(byte[])"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setFileContentMd5(byte[] fileContentMd5)"
name: "setFileContentMd5(byte[] fileContentMd5)"
nameWithType: "FileReadHeaders.setFileContentMd5(byte[] fileContentMd5)"
summary: "Set the file<wbr>ContentMD5 property: If the file has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value."
parameters:
- description: "the fileContentMD5 value to set."
name: "fileContentMd5"
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
syntax: "public FileReadHeaders setFileContentMd5(byte[] fileContentMd5)"
desc: "Set the fileContentMD5 property: If the file has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setLastModified(java.time.OffsetDateTime)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setLastModified(OffsetDateTime lastModified)"
name: "setLastModified(OffsetDateTime lastModified)"
nameWithType: "FileReadHeaders.setLastModified(OffsetDateTime lastModified)"
summary: "Set the last<wbr>Modified property: Returns the date and time the container was last modified."
parameters:
- description: "the lastModified value to set."
name: "lastModified"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
syntax: "public FileReadHeaders setLastModified(OffsetDateTime lastModified)"
desc: "Set the lastModified property: Returns the date and time the container was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setLeaseDuration(com.azure.storage.file.datalake.models.LeaseDurationType)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setLeaseDuration(LeaseDurationType leaseDuration)"
name: "setLeaseDuration(LeaseDurationType leaseDuration)"
nameWithType: "FileReadHeaders.setLeaseDuration(LeaseDurationType leaseDuration)"
summary: "Set the lease<wbr>Duration property: When a file is leased, specifies whether the lease is of infinite or fixed duration."
parameters:
- description: "the leaseDuration value to set."
name: "leaseDuration"
type: "<xref href=\"com.azure.storage.file.datalake.models.LeaseDurationType?alt=com.azure.storage.file.datalake.models.LeaseDurationType&text=LeaseDurationType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FileReadHeaders setLeaseDuration(LeaseDurationType leaseDuration)"
desc: "Set the leaseDuration property: When a file is leased, specifies whether the lease is of infinite or fixed duration. Possible values include: 'infinite', 'fixed'."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setLeaseState(com.azure.storage.file.datalake.models.LeaseStateType)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setLeaseState(LeaseStateType leaseState)"
name: "setLeaseState(LeaseStateType leaseState)"
nameWithType: "FileReadHeaders.setLeaseState(LeaseStateType leaseState)"
summary: "Set the lease<wbr>State property: Lease state of the file."
parameters:
- description: "the leaseState value to set."
name: "leaseState"
type: "<xref href=\"com.azure.storage.file.datalake.models.LeaseStateType?alt=com.azure.storage.file.datalake.models.LeaseStateType&text=LeaseStateType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FileReadHeaders setLeaseState(LeaseStateType leaseState)"
desc: "Set the leaseState property: Lease state of the file. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setLeaseStatus(com.azure.storage.file.datalake.models.LeaseStatusType)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setLeaseStatus(LeaseStatusType leaseStatus)"
name: "setLeaseStatus(LeaseStatusType leaseStatus)"
nameWithType: "FileReadHeaders.setLeaseStatus(LeaseStatusType leaseStatus)"
summary: "Set the lease<wbr>Status property: The current lease status of the file."
parameters:
- description: "the leaseStatus value to set."
name: "leaseStatus"
type: "<xref href=\"com.azure.storage.file.datalake.models.LeaseStatusType?alt=com.azure.storage.file.datalake.models.LeaseStatusType&text=LeaseStatusType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FileReadHeaders setLeaseStatus(LeaseStatusType leaseStatus)"
desc: "Set the leaseStatus property: The current lease status of the file. Possible values include: 'locked', 'unlocked'."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setMetadata(java.util.Map<java.lang.String,java.lang.String>)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setMetadata(Map<String,String> metadata)"
name: "setMetadata(Map<String,String> metadata)"
nameWithType: "FileReadHeaders.setMetadata(Map<String,String> metadata)"
summary: "Set the metadata property: The metadata property."
parameters:
- description: "the metadata value to set."
name: "metadata"
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 FileReadHeaders setMetadata(Map<String,String> metadata)"
desc: "Set the metadata property: The metadata property."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setRequestId(java.lang.String)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setRequestId(String requestId)"
name: "setRequestId(String requestId)"
nameWithType: "FileReadHeaders.setRequestId(String requestId)"
summary: "Set the request<wbr>Id property: This header uniquely identifies the request that was made and can be used for troubleshooting the request."
parameters:
- description: "the requestId value to set."
name: "requestId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileReadHeaders setRequestId(String requestId)"
desc: "Set the requestId property: This header uniquely identifies the request that was made and can be used for troubleshooting the request."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setServerEncrypted(java.lang.Boolean)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setServerEncrypted(Boolean serverEncrypted)"
name: "setServerEncrypted(Boolean serverEncrypted)"
nameWithType: "FileReadHeaders.setServerEncrypted(Boolean serverEncrypted)"
summary: "Set the is<wbr>Server<wbr>Encrypted property: The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm."
parameters:
- description: "the isServerEncrypted value to set."
name: "serverEncrypted"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public FileReadHeaders setServerEncrypted(Boolean serverEncrypted)"
desc: "Set the isServerEncrypted property: The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted)."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileReadHeaders.setVersion(java.lang.String)"
fullName: "com.azure.storage.file.datalake.models.FileReadHeaders.setVersion(String version)"
name: "setVersion(String version)"
nameWithType: "FileReadHeaders.setVersion(String version)"
summary: "Set the version property: Indicates the version of the Blob service used to execute the request."
parameters:
- description: "the version value to set."
name: "version"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileReadHeaders setVersion(String version)"
desc: "Set the version property: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
returns:
description: "the FileReadHeaders object itself."
type: "<xref href=\"com.azure.storage.file.datalake.models.FileReadHeaders?alt=com.azure.storage.file.datalake.models.FileReadHeaders&text=FileReadHeaders\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Defines headers for Read operation."
metadata: {}
package: "com.azure.storage.file.datalake.models"
artifact: com.azure:azure-storage-file-datalake:12.19.1