azure-docs-sdk-java/docs-ref-autogen/com.microsoft.azure.batch.p...

108 строки
8.2 KiB
YAML

### YamlMime:JavaType
uid: "com.microsoft.azure.batch.protocol.models.NodeRemoveParameter"
fullName: "com.microsoft.azure.batch.protocol.models.NodeRemoveParameter"
name: "NodeRemoveParameter"
nameWithType: "NodeRemoveParameter"
summary: "Options for removing Compute Nodes from a Pool."
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 **NodeRemoveParameter**"
constructors:
- uid: "com.microsoft.azure.batch.protocol.models.NodeRemoveParameter.NodeRemoveParameter()"
fullName: "com.microsoft.azure.batch.protocol.models.NodeRemoveParameter.NodeRemoveParameter()"
name: "NodeRemoveParameter()"
nameWithType: "NodeRemoveParameter.NodeRemoveParameter()"
syntax: "public NodeRemoveParameter()"
methods:
- uid: "com.microsoft.azure.batch.protocol.models.NodeRemoveParameter.nodeDeallocationOption()"
fullName: "com.microsoft.azure.batch.protocol.models.NodeRemoveParameter.nodeDeallocationOption()"
name: "nodeDeallocationOption()"
nameWithType: "NodeRemoveParameter.nodeDeallocationOption()"
summary: "Get the default value is requeue."
syntax: "public ComputeNodeDeallocationOption nodeDeallocationOption()"
desc: "Get the default value is requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData'."
returns:
description: "the nodeDeallocationOption value"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption&text=ComputeNodeDeallocationOption\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.NodeRemoveParameter.nodeList()"
fullName: "com.microsoft.azure.batch.protocol.models.NodeRemoveParameter.nodeList()"
name: "nodeList()"
nameWithType: "NodeRemoveParameter.nodeList()"
summary: "Get a maximum of 100 nodes may be removed per request."
syntax: "public List<String> nodeList()"
desc: "Get a maximum of 100 nodes may be removed per request."
returns:
description: "the nodeList value"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.microsoft.azure.batch.protocol.models.NodeRemoveParameter.resizeTimeout()"
fullName: "com.microsoft.azure.batch.protocol.models.NodeRemoveParameter.resizeTimeout()"
name: "resizeTimeout()"
nameWithType: "NodeRemoveParameter.resizeTimeout()"
summary: "Get the default value is 15 minutes."
syntax: "public Period resizeTimeout()"
desc: "Get 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: "<xref href=\"org.joda.time.Period?alt=org.joda.time.Period&text=Period\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.NodeRemoveParameter.withNodeDeallocationOption(com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption)"
fullName: "com.microsoft.azure.batch.protocol.models.NodeRemoveParameter.withNodeDeallocationOption(ComputeNodeDeallocationOption nodeDeallocationOption)"
name: "withNodeDeallocationOption(ComputeNodeDeallocationOption nodeDeallocationOption)"
nameWithType: "NodeRemoveParameter.withNodeDeallocationOption(ComputeNodeDeallocationOption nodeDeallocationOption)"
summary: "Set the default value is requeue."
parameters:
- description: "the nodeDeallocationOption value to set"
name: "nodeDeallocationOption"
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption?alt=com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption&text=ComputeNodeDeallocationOption\" data-throw-if-not-resolved=\"False\" />"
syntax: "public NodeRemoveParameter withNodeDeallocationOption(ComputeNodeDeallocationOption nodeDeallocationOption)"
desc: "Set the default value is requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData'."
returns:
description: "the NodeRemoveParameter object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.NodeRemoveParameter?alt=com.microsoft.azure.batch.protocol.models.NodeRemoveParameter&text=NodeRemoveParameter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.NodeRemoveParameter.withNodeList(java.util.List<java.lang.String>)"
fullName: "com.microsoft.azure.batch.protocol.models.NodeRemoveParameter.withNodeList(List<String> nodeList)"
name: "withNodeList(List<String> nodeList)"
nameWithType: "NodeRemoveParameter.withNodeList(List<String> nodeList)"
summary: "Set a maximum of 100 nodes may be removed per request."
parameters:
- description: "the nodeList value to set"
name: "nodeList"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public NodeRemoveParameter withNodeList(List<String> nodeList)"
desc: "Set a maximum of 100 nodes may be removed per request."
returns:
description: "the NodeRemoveParameter object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.NodeRemoveParameter?alt=com.microsoft.azure.batch.protocol.models.NodeRemoveParameter&text=NodeRemoveParameter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.batch.protocol.models.NodeRemoveParameter.withResizeTimeout(org.joda.time.Period)"
fullName: "com.microsoft.azure.batch.protocol.models.NodeRemoveParameter.withResizeTimeout(Period resizeTimeout)"
name: "withResizeTimeout(Period resizeTimeout)"
nameWithType: "NodeRemoveParameter.withResizeTimeout(Period resizeTimeout)"
summary: "Set the default value is 15 minutes."
parameters:
- description: "the resizeTimeout value to set"
name: "resizeTimeout"
type: "<xref href=\"org.joda.time.Period?alt=org.joda.time.Period&text=Period\" data-throw-if-not-resolved=\"False\" />"
syntax: "public NodeRemoveParameter withResizeTimeout(Period resizeTimeout)"
desc: "Set 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 NodeRemoveParameter object itself."
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.NodeRemoveParameter?alt=com.microsoft.azure.batch.protocol.models.NodeRemoveParameter&text=NodeRemoveParameter\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Options for removing Compute Nodes from a Pool."
metadata: {}
package: "com.microsoft.azure.batch.protocol.models"
artifact: com.microsoft.azure:azure-batch:11.2.0