Package com.microsoft.azure.batch.protocol.models

Class PoolListUsageMetricsOptions

  • public class PoolListUsageMetricsOptions
extends Object
    Additional parameters for listUsageMetrics operation.

    • Constructor Detail

      • PoolListUsageMetricsOptions

        public PoolListUsageMetricsOptions()

    • Method Detail

      • startTime

        public org.joda.time.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

      • withStartTime

        public PoolListUsageMetricsOptions withStartTime​(org.joda.time.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.

      • endTime

        public org.joda.time.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

      • withEndTime

        public PoolListUsageMetricsOptions withEndTime​(org.joda.time.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.

      • 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

      • 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.

      • 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

      • 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.

      • 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

      • 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.

      • 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

      • 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.

      • returnClientRequestId

        public Boolean returnClientRequestId()
        Get whether the server should return the client-request-id in the response.
        Returns:
        the returnClientRequestId value

      • 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.

      • ocpDate

        public org.joda.time.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

      • withOcpDate

        public PoolListUsageMetricsOptions withOcpDate​(org.joda.time.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.