-
Notifications
You must be signed in to change notification settings - Fork 258
/
com.azure.storage.file.datalake.models.FileRange.yml
92 lines (92 loc) · 6.05 KB
/
com.azure.storage.file.datalake.models.FileRange.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
### YamlMime:JavaType
uid: "com.azure.storage.file.datalake.models.FileRange"
fullName: "com.azure.storage.file.datalake.models.FileRange"
name: "FileRange"
nameWithType: "FileRange"
summary: "This is a representation of a range of bytes on a file, typically used during a download 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 **FileRange**"
constructors:
- uid: "com.azure.storage.file.datalake.models.FileRange.FileRange(long)"
fullName: "com.azure.storage.file.datalake.models.FileRange.FileRange(long offset)"
name: "FileRange(long offset)"
nameWithType: "FileRange.FileRange(long offset)"
summary: "Specifies the download operation to start from the offset position (zero-based) and download the rest of the entire file to the end."
parameters:
- description: "the zero-based position to start downloading"
name: "offset"
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FileRange(long offset)"
desc: "Specifies the download operation to start from the offset position (zero-based) and download the rest of the entire file to the end."
- uid: "com.azure.storage.file.datalake.models.FileRange.FileRange(long,java.lang.Long)"
fullName: "com.azure.storage.file.datalake.models.FileRange.FileRange(long offset, Long count)"
name: "FileRange(long offset, Long count)"
nameWithType: "FileRange.FileRange(long offset, Long count)"
summary: "Specifies the download operation to start from the offset position (zero-based) and download the count number of bytes."
parameters:
- description: "the zero-based position to start downloading"
name: "offset"
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- description: "the number of bytes to download"
name: "count"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
syntax: "public FileRange(long offset, Long count)"
desc: "Specifies the download operation to start from the offset position (zero-based) and download the count number of bytes."
methods:
- uid: "com.azure.storage.file.datalake.models.FileRange.getCount()"
fullName: "com.azure.storage.file.datalake.models.FileRange.getCount()"
name: "getCount()"
nameWithType: "FileRange.getCount()"
summary: "How many bytes to include in the range."
syntax: "public Long getCount()"
desc: "How many bytes to include in the range. Must be greater than or equal to 0 if specified."
returns:
description: "the number bytes to include in the range"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
- uid: "com.azure.storage.file.datalake.models.FileRange.getOffset()"
fullName: "com.azure.storage.file.datalake.models.FileRange.getOffset()"
name: "getOffset()"
nameWithType: "FileRange.getOffset()"
summary: "The start of the range."
syntax: "public long getOffset()"
desc: "The start of the range. Must be greater than or equal to 0."
returns:
description: "the offset for the range"
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.file.datalake.models.FileRange.toHeaderValue()"
fullName: "com.azure.storage.file.datalake.models.FileRange.toHeaderValue()"
name: "toHeaderValue()"
nameWithType: "FileRange.toHeaderValue()"
syntax: "public String toHeaderValue()"
returns:
description: "<xref uid=\"com.azure.storage.file.datalake.models.FileRange.toString()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FileRange#toString()\"></xref> if <code>count</code> isn't <code>null</code> or <code>offset</code> isn't 0, otherwise\n null."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.file.datalake.models.FileRange.toString()"
fullName: "com.azure.storage.file.datalake.models.FileRange.toString()"
name: "toString()"
nameWithType: "FileRange.toString()"
overridden: "java.lang.Object.toString()"
syntax: "public String toString()"
returns:
description: "A <code>String</code> compliant with the format of the Azure Storage x-ms-range and Range headers."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
type: "class"
desc: "This is a representation of a range of bytes on a file, typically used during a download operation. This type is immutable to ensure thread-safety of requests, so changing the values for a different operation requires construction of a new object. Passing null as a FileRange value will default to the entire range of the file."
metadata: {}
package: "com.azure.storage.file.datalake.models"
artifact: com.azure:azure-storage-file-datalake:12.20.0