JobGetAllLifetimeStatisticsOptions Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.JobGetAllLifetimeStatisticsOptions

public class JobGetAllLifetimeStatisticsOptions

Additional parameters for getAllLifetimeStatistics operation.

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. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
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.
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. The default is 30 seconds.
JobGetAllLifetimeStatisticsOptions 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.
JobGetAllLifetimeStatisticsOptions 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.
JobGetAllLifetimeStatisticsOptions withReturnClientRequestId(Boolean returnClientRequestId)

Set whether the server should return the client-request-id in the response.
JobGetAllLifetimeStatisticsOptions withTimeout(Integer timeout)

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

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 JobGetAllLifetimeStatisticsOptions 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 JobGetAllLifetimeStatisticsOptions object itself.

withOcpDate

public JobGetAllLifetimeStatisticsOptions 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 JobGetAllLifetimeStatisticsOptions object itself.

withReturnClientRequestId

public JobGetAllLifetimeStatisticsOptions 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 JobGetAllLifetimeStatisticsOptions object itself.

withTimeout

public JobGetAllLifetimeStatisticsOptions 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 JobGetAllLifetimeStatisticsOptions object itself.

Applies to