PoolEvaluateAutoScaleOptions Class

  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.PoolEvaluateAutoScaleOptions

public class PoolEvaluateAutoScaleOptions

Additional parameters for evaluateAutoScale operation.

Constructor Summary

Constructor Description
PoolEvaluateAutoScaleOptions()

Method Summary

Modifier and Type Method and Description
UUID clientRequestId()

Get the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.

org.joda.time.DateTime ocpDate()

Get the time the request was issued.

Boolean returnClientRequestId()

Get whether the server should return the client-request-id in the response.

Integer timeout()

Get the maximum time that the server can spend processing the request, in seconds.

PoolEvaluateAutoScaleOptions withClientRequestId(UUID clientRequestId)

Set the caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g.

PoolEvaluateAutoScaleOptions withOcpDate(DateTime ocpDate)

Set the time the request was issued.

PoolEvaluateAutoScaleOptions withReturnClientRequestId(Boolean returnClientRequestId)

Set whether the server should return the client-request-id in the response.

PoolEvaluateAutoScaleOptions withTimeout(Integer timeout)

Set the maximum time that the server can spend processing the request, in seconds.

Methods inherited from java.lang.Object

Constructor Details

PoolEvaluateAutoScaleOptions

public PoolEvaluateAutoScaleOptions()

Method Details

clientRequestId

public UUID clientRequestId()

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:

the clientRequestId value

ocpDate

public DateTime ocpDate()

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:

the ocpDate value

returnClientRequestId

public Boolean returnClientRequestId()

Get whether the server should return the client-request-id in the response.

Returns:

the returnClientRequestId value

timeout

public Integer timeout()

Get the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

Returns:

the timeout value

withClientRequestId

public PoolEvaluateAutoScaleOptions withClientRequestId(UUID clientRequestId)

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.

Parameters:

clientRequestId - the clientRequestId value to set

Returns:

the PoolEvaluateAutoScaleOptions object itself.

withOcpDate

public PoolEvaluateAutoScaleOptions withOcpDate(DateTime ocpDate)

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.

Parameters:

ocpDate - the ocpDate value to set

Returns:

the PoolEvaluateAutoScaleOptions object itself.

withReturnClientRequestId

public PoolEvaluateAutoScaleOptions withReturnClientRequestId(Boolean returnClientRequestId)

Set whether the server should return the client-request-id in the response.

Parameters:

returnClientRequestId - the returnClientRequestId value to set

Returns:

the PoolEvaluateAutoScaleOptions object itself.

withTimeout

public PoolEvaluateAutoScaleOptions withTimeout(Integer timeout)

Set the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.

Parameters:

timeout - the timeout value to set

Returns:

the PoolEvaluateAutoScaleOptions object itself.

Applies to