-
Notifications
You must be signed in to change notification settings - Fork 241
/
com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.yml
179 lines (179 loc) · 13.1 KB
/
com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.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
### YamlMime:JavaType
uid: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions"
fullName: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions"
name: "FileListFromTaskOptions"
nameWithType: "FileListFromTaskOptions"
summary: "Additional parameters for list<wbr>From<wbr>Task 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 class **FileListFromTaskOptions**"
constructors:
- uid: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.FileListFromTaskOptions()"
fullName: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.FileListFromTaskOptions()"
name: "FileListFromTaskOptions()"
nameWithType: "FileListFromTaskOptions.FileListFromTaskOptions()"
syntax: "public FileListFromTaskOptions()"
methods:
- uid: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.clientRequestId()"
fullName: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.clientRequestId()"
name: "clientRequestId()"
nameWithType: "FileListFromTaskOptions.clientRequestId()"
summary: "Get the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.<wbr>g."
syntax: "public UUID clientRequestId()"
desc: "Get the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0."
returns:
description: "the clientRequestId value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html\">UUID</a>"
- uid: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.filter()"
fullName: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.filter()"
name: "filter()"
nameWithType: "FileListFromTaskOptions.filter()"
summary: "Get an OData $filter clause."
syntax: "public String filter()"
desc: "Get an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch\\#list-task-files."
returns:
description: "the filter value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.maxResults()"
fullName: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.maxResults()"
name: "maxResults()"
nameWithType: "FileListFromTaskOptions.maxResults()"
summary: "Get the maximum number of items to return in the response."
syntax: "public Integer maxResults()"
desc: "Get the maximum number of items to return in the response. A maximum of 1000 files can be returned."
returns:
description: "the maxResults value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.ocpDate()"
fullName: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.ocpDate()"
name: "ocpDate()"
nameWithType: "FileListFromTaskOptions.ocpDate()"
summary: "Get the time the request was issued."
syntax: "public DateTime ocpDate()"
desc: "Get the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly."
returns:
description: "the ocpDate value"
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.returnClientRequestId()"
fullName: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.returnClientRequestId()"
name: "returnClientRequestId()"
nameWithType: "FileListFromTaskOptions.returnClientRequestId()"
summary: "Get whether the server should return the client-request-id in the response."
syntax: "public Boolean returnClientRequestId()"
desc: "Get whether the server should return the client-request-id in the response."
returns:
description: "the returnClientRequestId value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.timeout()"
fullName: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.timeout()"
name: "timeout()"
nameWithType: "FileListFromTaskOptions.timeout()"
summary: "Get the maximum time that the server can spend processing the request, in seconds."
syntax: "public Integer timeout()"
desc: "Get the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead."
returns:
description: "the timeout value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.withClientRequestId(java.util.UUID)"
fullName: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.withClientRequestId(UUID clientRequestId)"
name: "withClientRequestId(UUID clientRequestId)"
nameWithType: "FileListFromTaskOptions.withClientRequestId(UUID clientRequestId)"
summary: "Set the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.<wbr>g."
parameters:
- description: "the clientRequestId value to set"
name: "clientRequestId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html\">UUID</a>"
syntax: "public FileListFromTaskOptions withClientRequestId(UUID clientRequestId)"
desc: "Set the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0."
returns:
description: "the FileListFromTaskOptions object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions?alt=com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions&text=FileListFromTaskOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.withFilter(java.lang.String)"
fullName: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.withFilter(String filter)"
name: "withFilter(String filter)"
nameWithType: "FileListFromTaskOptions.withFilter(String filter)"
summary: "Set an OData $filter clause."
parameters:
- description: "the filter value to set"
name: "filter"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public FileListFromTaskOptions withFilter(String filter)"
desc: "Set an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/rest/api/batchservice/odata-filters-in-batch\\#list-task-files."
returns:
description: "the FileListFromTaskOptions object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions?alt=com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions&text=FileListFromTaskOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.withMaxResults(java.lang.Integer)"
fullName: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.withMaxResults(Integer maxResults)"
name: "withMaxResults(Integer maxResults)"
nameWithType: "FileListFromTaskOptions.withMaxResults(Integer maxResults)"
summary: "Set the maximum number of items to return in the response."
parameters:
- description: "the maxResults value to set"
name: "maxResults"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public FileListFromTaskOptions withMaxResults(Integer maxResults)"
desc: "Set the maximum number of items to return in the response. A maximum of 1000 files can be returned."
returns:
description: "the FileListFromTaskOptions object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions?alt=com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions&text=FileListFromTaskOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.withOcpDate(org.joda.time.DateTime)"
fullName: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.withOcpDate(DateTime ocpDate)"
name: "withOcpDate(DateTime ocpDate)"
nameWithType: "FileListFromTaskOptions.withOcpDate(DateTime ocpDate)"
summary: "Set the time the request was issued."
parameters:
- description: "the ocpDate value to set"
name: "ocpDate"
type: "<xref href=\"org.joda.time.DateTime?alt=org.joda.time.DateTime&text=DateTime\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FileListFromTaskOptions withOcpDate(DateTime ocpDate)"
desc: "Set the time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly."
returns:
description: "the FileListFromTaskOptions object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions?alt=com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions&text=FileListFromTaskOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.withReturnClientRequestId(java.lang.Boolean)"
fullName: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.withReturnClientRequestId(Boolean returnClientRequestId)"
name: "withReturnClientRequestId(Boolean returnClientRequestId)"
nameWithType: "FileListFromTaskOptions.withReturnClientRequestId(Boolean returnClientRequestId)"
summary: "Set whether the server should return the client-request-id in the response."
parameters:
- description: "the returnClientRequestId value to set"
name: "returnClientRequestId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public FileListFromTaskOptions withReturnClientRequestId(Boolean returnClientRequestId)"
desc: "Set whether the server should return the client-request-id in the response."
returns:
description: "the FileListFromTaskOptions object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions?alt=com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions&text=FileListFromTaskOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.withTimeout(java.lang.Integer)"
fullName: "com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions.withTimeout(Integer timeout)"
name: "withTimeout(Integer timeout)"
nameWithType: "FileListFromTaskOptions.withTimeout(Integer timeout)"
summary: "Set the maximum time that the server can spend processing the request, in seconds."
parameters:
- description: "the timeout value to set"
name: "timeout"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public FileListFromTaskOptions withTimeout(Integer timeout)"
desc: "Set the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead."
returns:
description: "the FileListFromTaskOptions object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions?alt=com.microsoft.azure.batch.protocol.models.FileListFromTaskOptions&text=FileListFromTaskOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Additional parameters for listFromTask operation."
metadata: {}
package: "com.microsoft.azure.batch.protocol.models"
artifact: com.microsoft.azure:azure-batch:11.2.0