Interface BatchGetFrameMetricDataResponse.Builder

    • Method Detail

      • endTime

        BatchGetFrameMetricDataResponse.Builder endTime​(Instant endTime)

        The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

        Parameters:
        endTime - The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • endTimes

        BatchGetFrameMetricDataResponse.Builder endTimes​(Collection<TimestampStructure> endTimes)

        List of instances, or time steps, in the time series. For example, if the period is one day ( PT24H)), and the resolution is five minutes (PT5M), then there are 288 endTimes in the list that are each five minutes appart.

        Parameters:
        endTimes - List of instances, or time steps, in the time series. For example, if the period is one day (PT24H)), and the resolution is five minutes (PT5M), then there are 288 endTimes in the list that are each five minutes appart.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • endTimes

        BatchGetFrameMetricDataResponse.Builder endTimes​(TimestampStructure... endTimes)

        List of instances, or time steps, in the time series. For example, if the period is one day ( PT24H)), and the resolution is five minutes (PT5M), then there are 288 endTimes in the list that are each five minutes appart.

        Parameters:
        endTimes - List of instances, or time steps, in the time series. For example, if the period is one day (PT24H)), and the resolution is five minutes (PT5M), then there are 288 endTimes in the list that are each five minutes appart.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • frameMetricData

        BatchGetFrameMetricDataResponse.Builder frameMetricData​(Collection<FrameMetricDatum> frameMetricData)

        Details of the metrics to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.

        Parameters:
        frameMetricData - Details of the metrics to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • frameMetricData

        BatchGetFrameMetricDataResponse.Builder frameMetricData​(FrameMetricDatum... frameMetricData)

        Details of the metrics to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.

        Parameters:
        frameMetricData - Details of the metrics to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • frameMetricData

        BatchGetFrameMetricDataResponse.Builder frameMetricData​(Consumer<FrameMetricDatum.Builder>... frameMetricData)

        Details of the metrics to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.

        This is a convenience method that creates an instance of the FrameMetricDatum.Builder avoiding the need to create one manually via FrameMetricDatum.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #frameMetricData(List).

        Parameters:
        frameMetricData - a consumer that will call methods on FrameMetricDatum.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #frameMetricData(java.util.Collection)
      • resolution

        BatchGetFrameMetricDataResponse.Builder resolution​(String resolution)

        Resolution or granularity of the profile data used to generate the time series. This is the value used to jump through time steps in a time series. There are 3 valid values.

        • P1D — 1 day

        • PT1H — 1 hour

        • PT5M — 5 minutes

        Parameters:
        resolution - Resolution or granularity of the profile data used to generate the time series. This is the value used to jump through time steps in a time series. There are 3 valid values.

        • P1D — 1 day

        • PT1H — 1 hour

        • PT5M — 5 minutes

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AggregationPeriod, AggregationPeriod
      • resolution

        BatchGetFrameMetricDataResponse.Builder resolution​(AggregationPeriod resolution)

        Resolution or granularity of the profile data used to generate the time series. This is the value used to jump through time steps in a time series. There are 3 valid values.

        • P1D — 1 day

        • PT1H — 1 hour

        • PT5M — 5 minutes

        Parameters:
        resolution - Resolution or granularity of the profile data used to generate the time series. This is the value used to jump through time steps in a time series. There are 3 valid values.

        • P1D — 1 day

        • PT1H — 1 hour

        • PT5M — 5 minutes

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AggregationPeriod, AggregationPeriod
      • startTime

        BatchGetFrameMetricDataResponse.Builder startTime​(Instant startTime)

        The start time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

        Parameters:
        startTime - The start time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • unprocessedEndTimes

        BatchGetFrameMetricDataResponse.Builder unprocessedEndTimes​(Map<String,​? extends Collection<TimestampStructure>> unprocessedEndTimes)

        List of instances which remained unprocessed. This will create a missing time step in the list of end times.

        Parameters:
        unprocessedEndTimes - List of instances which remained unprocessed. This will create a missing time step in the list of end times.
        Returns:
        Returns a reference to this object so that method calls can be chained together.