Package com.azure.compute.batch.models
Class TerminateBatchJobOptions
java.lang.Object
com.azure.compute.batch.models.TerminateBatchJobOptions
Optional parameters for Terminate Job operation.
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an instance of TerminateBatchJobOptions class. -
Method Summary
Modifier and TypeMethodDescriptionGet the parameters property: The options to use for terminating the Job.Get the timeOutInSeconds property: The maximum time that the server can spend processing the request, in seconds.isForce()
Get the force property: If true, the server will terminate the Job even if the corresponding nodes have not fully processed the termination.Set the force property: If true, the server will terminate the Job even if the corresponding nodes have not fully processed the termination.setParameters
(BatchJobTerminateContent parameters) Set the parameters property: The options to use for terminating the Job.setTimeOutInSeconds
(Integer timeOutInSeconds) Set the timeOutInSeconds property: The maximum time that the server can spend processing the request, in seconds.
-
Constructor Details
-
TerminateBatchJobOptions
public TerminateBatchJobOptions()Creates an instance of TerminateBatchJobOptions class.
-
-
Method Details
-
getTimeOutInSeconds
Get the timeOutInSeconds property: 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:
- the timeOutInSeconds value.
-
setTimeOutInSeconds
Set the timeOutInSeconds property: 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.".- Parameters:
timeOutInSeconds
- the timeOutInSeconds value to set.- Returns:
- the TerminateBatchJobOptions object itself.
-
getParameters
Get the parameters property: The options to use for terminating the Job.- Returns:
- the parameters value.
-
setParameters
Set the parameters property: The options to use for terminating the Job.- Parameters:
parameters
- the parameters value to set.- Returns:
- the TerminateBatchJobOptions object itself.
-
isForce
Get the force property: If true, the server will terminate the Job even if the corresponding nodes have not fully processed the termination. The default value is false.- Returns:
- the force value.
-
setForce
Set the force property: If true, the server will terminate the Job even if the corresponding nodes have not fully processed the termination. The default value is false.- Parameters:
force
- the force value to set.- Returns:
- the TerminateBatchJobOptions object itself.
-