-
Notifications
You must be signed in to change notification settings - Fork 223
/
com.azure.resourcemanager.batch.models.ResizeOperationStatus.yml
186 lines (186 loc) · 15.8 KB
/
com.azure.resourcemanager.batch.models.ResizeOperationStatus.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
### YamlMime:JavaType
uid: "com.azure.resourcemanager.batch.models.ResizeOperationStatus"
fullName: "com.azure.resourcemanager.batch.models.ResizeOperationStatus"
name: "ResizeOperationStatus"
nameWithType: "ResizeOperationStatus"
summary: "Details about the current or last completed resize 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 **ResizeOperationStatus**"
constructors:
- uid: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.ResizeOperationStatus()"
fullName: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.ResizeOperationStatus()"
name: "ResizeOperationStatus()"
nameWithType: "ResizeOperationStatus.ResizeOperationStatus()"
syntax: "public ResizeOperationStatus()"
methods:
- uid: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.errors()"
fullName: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.errors()"
name: "errors()"
nameWithType: "ResizeOperationStatus.errors()"
summary: "Get the errors property: Details of any errors encountered while performing the last resize on the pool."
syntax: "public List<ResizeError> errors()"
desc: "Get the errors property: Details of any errors encountered while performing the last resize on the pool. This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady."
returns:
description: "the errors value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.batch.models.ResizeError?alt=com.azure.resourcemanager.batch.models.ResizeError&text=ResizeError\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.nodeDeallocationOption()"
fullName: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.nodeDeallocationOption()"
name: "nodeDeallocationOption()"
nameWithType: "ResizeOperationStatus.nodeDeallocationOption()"
summary: "Get the node<wbr>Deallocation<wbr>Option property: Determines what to do with a node and its running task(s) after it has been selected for deallocation."
syntax: "public ComputeNodeDeallocationOption nodeDeallocationOption()"
desc: "Get the nodeDeallocationOption property: Determines what to do with a node and its running task(s) after it has been selected for deallocation. The default value is requeue."
returns:
description: "the nodeDeallocationOption value."
type: "<xref href=\"com.azure.resourcemanager.batch.models.ComputeNodeDeallocationOption?alt=com.azure.resourcemanager.batch.models.ComputeNodeDeallocationOption&text=ComputeNodeDeallocationOption\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.resizeTimeout()"
fullName: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.resizeTimeout()"
name: "resizeTimeout()"
nameWithType: "ResizeOperationStatus.resizeTimeout()"
summary: "Get the resize<wbr>Timeout property: The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool."
syntax: "public Duration resizeTimeout()"
desc: "Get the resizeTimeout property: The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)."
returns:
description: "the resizeTimeout value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
- uid: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.startTime()"
fullName: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.startTime()"
name: "startTime()"
nameWithType: "ResizeOperationStatus.startTime()"
summary: "Get the start<wbr>Time property: The time when this resize operation was started."
syntax: "public OffsetDateTime startTime()"
desc: "Get the startTime property: The time when this resize operation was started."
returns:
description: "the startTime value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.targetDedicatedNodes()"
fullName: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.targetDedicatedNodes()"
name: "targetDedicatedNodes()"
nameWithType: "ResizeOperationStatus.targetDedicatedNodes()"
summary: "Get the target<wbr>Dedicated<wbr>Nodes property: The desired number of dedicated compute nodes in the pool."
syntax: "public Integer targetDedicatedNodes()"
desc: "Get the targetDedicatedNodes property: The desired number of dedicated compute nodes in the pool."
returns:
description: "the targetDedicatedNodes value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.targetLowPriorityNodes()"
fullName: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.targetLowPriorityNodes()"
name: "targetLowPriorityNodes()"
nameWithType: "ResizeOperationStatus.targetLowPriorityNodes()"
summary: "Get the target<wbr>Low<wbr>Priority<wbr>Nodes property: The desired number of Spot/low-priority compute nodes in the pool."
syntax: "public Integer targetLowPriorityNodes()"
desc: "Get the targetLowPriorityNodes property: The desired number of Spot/low-priority compute nodes in the pool."
returns:
description: "the targetLowPriorityNodes value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.validate()"
fullName: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.validate()"
name: "validate()"
nameWithType: "ResizeOperationStatus.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.withErrors(java.util.List<com.azure.resourcemanager.batch.models.ResizeError>)"
fullName: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.withErrors(List<ResizeError> errors)"
name: "withErrors(List<ResizeError> errors)"
nameWithType: "ResizeOperationStatus.withErrors(List<ResizeError> errors)"
summary: "Set the errors property: Details of any errors encountered while performing the last resize on the pool."
parameters:
- description: "the errors value to set."
name: "errors"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.resourcemanager.batch.models.ResizeError?alt=com.azure.resourcemanager.batch.models.ResizeError&text=ResizeError\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public ResizeOperationStatus withErrors(List<ResizeError> errors)"
desc: "Set the errors property: Details of any errors encountered while performing the last resize on the pool. This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady."
returns:
description: "the ResizeOperationStatus object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.ResizeOperationStatus?alt=com.azure.resourcemanager.batch.models.ResizeOperationStatus&text=ResizeOperationStatus\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.withNodeDeallocationOption(com.azure.resourcemanager.batch.models.ComputeNodeDeallocationOption)"
fullName: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.withNodeDeallocationOption(ComputeNodeDeallocationOption nodeDeallocationOption)"
name: "withNodeDeallocationOption(ComputeNodeDeallocationOption nodeDeallocationOption)"
nameWithType: "ResizeOperationStatus.withNodeDeallocationOption(ComputeNodeDeallocationOption nodeDeallocationOption)"
summary: "Set the node<wbr>Deallocation<wbr>Option property: Determines what to do with a node and its running task(s) after it has been selected for deallocation."
parameters:
- description: "the nodeDeallocationOption value to set."
name: "nodeDeallocationOption"
type: "<xref href=\"com.azure.resourcemanager.batch.models.ComputeNodeDeallocationOption?alt=com.azure.resourcemanager.batch.models.ComputeNodeDeallocationOption&text=ComputeNodeDeallocationOption\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResizeOperationStatus withNodeDeallocationOption(ComputeNodeDeallocationOption nodeDeallocationOption)"
desc: "Set the nodeDeallocationOption property: Determines what to do with a node and its running task(s) after it has been selected for deallocation. The default value is requeue."
returns:
description: "the ResizeOperationStatus object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.ResizeOperationStatus?alt=com.azure.resourcemanager.batch.models.ResizeOperationStatus&text=ResizeOperationStatus\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.withResizeTimeout(java.time.Duration)"
fullName: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.withResizeTimeout(Duration resizeTimeout)"
name: "withResizeTimeout(Duration resizeTimeout)"
nameWithType: "ResizeOperationStatus.withResizeTimeout(Duration resizeTimeout)"
summary: "Set the resize<wbr>Timeout property: The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool."
parameters:
- description: "the resizeTimeout value to set."
name: "resizeTimeout"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
syntax: "public ResizeOperationStatus withResizeTimeout(Duration resizeTimeout)"
desc: "Set the resizeTimeout property: The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)."
returns:
description: "the ResizeOperationStatus object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.ResizeOperationStatus?alt=com.azure.resourcemanager.batch.models.ResizeOperationStatus&text=ResizeOperationStatus\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.withStartTime(java.time.OffsetDateTime)"
fullName: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.withStartTime(OffsetDateTime startTime)"
name: "withStartTime(OffsetDateTime startTime)"
nameWithType: "ResizeOperationStatus.withStartTime(OffsetDateTime startTime)"
summary: "Set the start<wbr>Time property: The time when this resize operation was started."
parameters:
- description: "the startTime value to set."
name: "startTime"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
syntax: "public ResizeOperationStatus withStartTime(OffsetDateTime startTime)"
desc: "Set the startTime property: The time when this resize operation was started."
returns:
description: "the ResizeOperationStatus object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.ResizeOperationStatus?alt=com.azure.resourcemanager.batch.models.ResizeOperationStatus&text=ResizeOperationStatus\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.withTargetDedicatedNodes(java.lang.Integer)"
fullName: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.withTargetDedicatedNodes(Integer targetDedicatedNodes)"
name: "withTargetDedicatedNodes(Integer targetDedicatedNodes)"
nameWithType: "ResizeOperationStatus.withTargetDedicatedNodes(Integer targetDedicatedNodes)"
summary: "Set the target<wbr>Dedicated<wbr>Nodes property: The desired number of dedicated compute nodes in the pool."
parameters:
- description: "the targetDedicatedNodes value to set."
name: "targetDedicatedNodes"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public ResizeOperationStatus withTargetDedicatedNodes(Integer targetDedicatedNodes)"
desc: "Set the targetDedicatedNodes property: The desired number of dedicated compute nodes in the pool."
returns:
description: "the ResizeOperationStatus object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.ResizeOperationStatus?alt=com.azure.resourcemanager.batch.models.ResizeOperationStatus&text=ResizeOperationStatus\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.withTargetLowPriorityNodes(java.lang.Integer)"
fullName: "com.azure.resourcemanager.batch.models.ResizeOperationStatus.withTargetLowPriorityNodes(Integer targetLowPriorityNodes)"
name: "withTargetLowPriorityNodes(Integer targetLowPriorityNodes)"
nameWithType: "ResizeOperationStatus.withTargetLowPriorityNodes(Integer targetLowPriorityNodes)"
summary: "Set the target<wbr>Low<wbr>Priority<wbr>Nodes property: The desired number of Spot/low-priority compute nodes in the pool."
parameters:
- description: "the targetLowPriorityNodes value to set."
name: "targetLowPriorityNodes"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public ResizeOperationStatus withTargetLowPriorityNodes(Integer targetLowPriorityNodes)"
desc: "Set the targetLowPriorityNodes property: The desired number of Spot/low-priority compute nodes in the pool."
returns:
description: "the ResizeOperationStatus object itself."
type: "<xref href=\"com.azure.resourcemanager.batch.models.ResizeOperationStatus?alt=com.azure.resourcemanager.batch.models.ResizeOperationStatus&text=ResizeOperationStatus\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Details about the current or last completed resize operation. Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady)."
metadata: {}
package: "com.azure.resourcemanager.batch.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-batch:1.0.0