-
Notifications
You must be signed in to change notification settings - Fork 241
/
com.microsoft.azure.batch.protocol.models.TaskAddOptions.yml
131 lines (131 loc) · 9.21 KB
/
com.microsoft.azure.batch.protocol.models.TaskAddOptions.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
### YamlMime:JavaType
uid: "com.microsoft.azure.batch.protocol.models.TaskAddOptions"
fullName: "com.microsoft.azure.batch.protocol.models.TaskAddOptions"
name: "TaskAddOptions"
nameWithType: "TaskAddOptions"
summary: "Additional parameters for add 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 **TaskAddOptions**"
constructors:
- uid: "com.microsoft.azure.batch.protocol.models.TaskAddOptions.TaskAddOptions()"
fullName: "com.microsoft.azure.batch.protocol.models.TaskAddOptions.TaskAddOptions()"
name: "TaskAddOptions()"
nameWithType: "TaskAddOptions.TaskAddOptions()"
syntax: "public TaskAddOptions()"
methods:
- uid: "com.microsoft.azure.batch.protocol.models.TaskAddOptions.clientRequestId()"
fullName: "com.microsoft.azure.batch.protocol.models.TaskAddOptions.clientRequestId()"
name: "clientRequestId()"
nameWithType: "TaskAddOptions.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.TaskAddOptions.ocpDate()"
fullName: "com.microsoft.azure.batch.protocol.models.TaskAddOptions.ocpDate()"
name: "ocpDate()"
nameWithType: "TaskAddOptions.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.TaskAddOptions.returnClientRequestId()"
fullName: "com.microsoft.azure.batch.protocol.models.TaskAddOptions.returnClientRequestId()"
name: "returnClientRequestId()"
nameWithType: "TaskAddOptions.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.TaskAddOptions.timeout()"
fullName: "com.microsoft.azure.batch.protocol.models.TaskAddOptions.timeout()"
name: "timeout()"
nameWithType: "TaskAddOptions.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.TaskAddOptions.withClientRequestId(java.util.UUID)"
fullName: "com.microsoft.azure.batch.protocol.models.TaskAddOptions.withClientRequestId(UUID clientRequestId)"
name: "withClientRequestId(UUID clientRequestId)"
nameWithType: "TaskAddOptions.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 TaskAddOptions 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 TaskAddOptions object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.TaskAddOptions?alt=com.microsoft.azure.batch.protocol.models.TaskAddOptions&text=TaskAddOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.TaskAddOptions.withOcpDate(org.joda.time.DateTime)"
fullName: "com.microsoft.azure.batch.protocol.models.TaskAddOptions.withOcpDate(DateTime ocpDate)"
name: "withOcpDate(DateTime ocpDate)"
nameWithType: "TaskAddOptions.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 TaskAddOptions 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 TaskAddOptions object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.TaskAddOptions?alt=com.microsoft.azure.batch.protocol.models.TaskAddOptions&text=TaskAddOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.TaskAddOptions.withReturnClientRequestId(java.lang.Boolean)"
fullName: "com.microsoft.azure.batch.protocol.models.TaskAddOptions.withReturnClientRequestId(Boolean returnClientRequestId)"
name: "withReturnClientRequestId(Boolean returnClientRequestId)"
nameWithType: "TaskAddOptions.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 TaskAddOptions withReturnClientRequestId(Boolean returnClientRequestId)"
desc: "Set whether the server should return the client-request-id in the response."
returns:
description: "the TaskAddOptions object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.TaskAddOptions?alt=com.microsoft.azure.batch.protocol.models.TaskAddOptions&text=TaskAddOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.TaskAddOptions.withTimeout(java.lang.Integer)"
fullName: "com.microsoft.azure.batch.protocol.models.TaskAddOptions.withTimeout(Integer timeout)"
name: "withTimeout(Integer timeout)"
nameWithType: "TaskAddOptions.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 TaskAddOptions 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 TaskAddOptions object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.TaskAddOptions?alt=com.microsoft.azure.batch.protocol.models.TaskAddOptions&text=TaskAddOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Additional parameters for add operation."
metadata: {}
package: "com.microsoft.azure.batch.protocol.models"
artifact: com.microsoft.azure:azure-batch:11.2.0