PoolListUsageMetricsOptions Class

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

public class PoolListUsageMetricsOptions

Additional parameters for listUsageMetrics 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 endTime()

Get the latest time from which to include metrics. This must be at least two hours before the current time. If not specified this defaults to the end time of the last aggregation interval currently available.
String filter()

Get an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.
Integer maxResults()

Get the maximum number of items to return in the response. A maximum of 1000 results will be returned.
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.
DateTime startTime()

Get the earliest time from which to include metrics. This must be at least two and a half hours before the current time. If not specified this defaults to the start time of the last aggregation interval currently available.
Integer timeout()

Get the maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.
PoolListUsageMetricsOptions 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.
PoolListUsageMetricsOptions withEndTime(DateTime endTime)

Set the latest time from which to include metrics. This must be at least two hours before the current time. If not specified this defaults to the end time of the last aggregation interval currently available.
PoolListUsageMetricsOptions withFilter(String filter)

Set an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.
PoolListUsageMetricsOptions withMaxResults(Integer maxResults)

Set the maximum number of items to return in the response. A maximum of 1000 results will be returned.
PoolListUsageMetricsOptions 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.
PoolListUsageMetricsOptions withReturnClientRequestId(Boolean returnClientRequestId)

Set whether the server should return the client-request-id in the response.
PoolListUsageMetricsOptions withStartTime(DateTime startTime)

Set the earliest time from which to include metrics. This must be at least two and a half hours before the current time. If not specified this defaults to the start time of the last aggregation interval currently available.
PoolListUsageMetricsOptions 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

endTime

public DateTime endTime()

Get the latest time from which to include metrics. This must be at least two hours before the current time. If not specified this defaults to the end time of the last aggregation interval currently available.

Returns:

the endTime value

filter

public String filter()

Get an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.

Returns:

the filter value

maxResults

public Integer maxResults()

Get the maximum number of items to return in the response. A maximum of 1000 results will be returned.

Returns:

the maxResults 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

startTime

public DateTime startTime()

Get the earliest time from which to include metrics. This must be at least two and a half hours before the current time. If not specified this defaults to the start time of the last aggregation interval currently available.

Returns:

the startTime 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 PoolListUsageMetricsOptions 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 PoolListUsageMetricsOptions object itself.

withEndTime

public PoolListUsageMetricsOptions withEndTime(DateTime endTime)

Set the latest time from which to include metrics. This must be at least two hours before the current time. If not specified this defaults to the end time of the last aggregation interval currently available.

Parameters:

endTime - the endTime value to set

Returns:

the PoolListUsageMetricsOptions object itself.

withFilter

public PoolListUsageMetricsOptions withFilter(String filter)

Set an OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.

Parameters:

filter - the filter value to set

Returns:

the PoolListUsageMetricsOptions object itself.

withMaxResults

public PoolListUsageMetricsOptions withMaxResults(Integer maxResults)

Set the maximum number of items to return in the response. A maximum of 1000 results will be returned.

Parameters:

maxResults - the maxResults value to set

Returns:

the PoolListUsageMetricsOptions object itself.

withOcpDate

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

withReturnClientRequestId

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

withStartTime

public PoolListUsageMetricsOptions withStartTime(DateTime startTime)

Set the earliest time from which to include metrics. This must be at least two and a half hours before the current time. If not specified this defaults to the start time of the last aggregation interval currently available.

Parameters:

startTime - the startTime value to set

Returns:

the PoolListUsageMetricsOptions object itself.

withTimeout

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

Applies to