Interface BatchGetFrameMetricDataRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CodeGuruProfilerRequest.Builder, CopyableBuilder<BatchGetFrameMetricDataRequest.Builder,BatchGetFrameMetricDataRequest>, SdkBuilder<BatchGetFrameMetricDataRequest.Builder,BatchGetFrameMetricDataRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
BatchGetFrameMetricDataRequest
@Mutable @NotThreadSafe public static interface BatchGetFrameMetricDataRequest.Builder extends CodeGuruProfilerRequest.Builder, SdkPojo, CopyableBuilder<BatchGetFrameMetricDataRequest.Builder,BatchGetFrameMetricDataRequest>

  • Method Details

    • endTime

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

    • frameMetrics

      BatchGetFrameMetricDataRequest.Builder frameMetrics(Collection<FrameMetric> frameMetrics)

      The details of the metrics that are used 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:
      frameMetrics - The details of the metrics that are used 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.

    • frameMetrics

      BatchGetFrameMetricDataRequest.Builder frameMetrics(FrameMetric... frameMetrics)

      The details of the metrics that are used 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:
      frameMetrics - The details of the metrics that are used 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.

    • frameMetrics

      BatchGetFrameMetricDataRequest.Builder frameMetrics(Consumer<FrameMetric.Builder>... frameMetrics)

      The details of the metrics that are used 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 FrameMetric.Builder avoiding the need to create one manually via FrameMetric.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to frameMetrics(List<FrameMetric>).

      Parameters:
      frameMetrics - a consumer that will call methods on FrameMetric.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • period

      BatchGetFrameMetricDataRequest.Builder period(String period)

      The duration of the frame metrics used to return the time series values. Specify using the ISO 8601 format. The maximum period duration is one day (PT24H or P1D).

      Parameters:
      period - The duration of the frame metrics used to return the time series values. Specify using the ISO 8601 format. The maximum period duration is one day (PT24H or P1D).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • profilingGroupName

      BatchGetFrameMetricDataRequest.Builder profilingGroupName(String profilingGroupName)

      The name of the profiling group associated with the the frame metrics used to return the time series values.

      Parameters:
      profilingGroupName - The name of the profiling group associated with the the frame metrics used to return the time series values.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTime

      BatchGetFrameMetricDataRequest.Builder startTime(Instant startTime)

      The start time of the time period for the frame metrics used to return the 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 frame metrics used to return the 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.

    • targetResolution

      BatchGetFrameMetricDataRequest.Builder targetResolution(String targetResolution)

      The requested resolution of time steps for the returned time series of values. If the requested target resolution is not available due to data not being retained we provide a best effort result by falling back to the most granular available resolution after the target resolution. There are 3 valid values.

      • P1D — 1 day

      • PT1H — 1 hour

      • PT5M — 5 minutes

      Parameters:
      targetResolution - The requested resolution of time steps for the returned time series of values. If the requested target resolution is not available due to data not being retained we provide a best effort result by falling back to the most granular available resolution after the target resolution. 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:

    • targetResolution

      BatchGetFrameMetricDataRequest.Builder targetResolution(AggregationPeriod targetResolution)

      The requested resolution of time steps for the returned time series of values. If the requested target resolution is not available due to data not being retained we provide a best effort result by falling back to the most granular available resolution after the target resolution. There are 3 valid values.

      • P1D — 1 day

      • PT1H — 1 hour

      • PT5M — 5 minutes

      Parameters:
      targetResolution - The requested resolution of time steps for the returned time series of values. If the requested target resolution is not available due to data not being retained we provide a best effort result by falling back to the most granular available resolution after the target resolution. 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:

    • overrideConfiguration

      BatchGetFrameMetricDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      BatchGetFrameMetricDataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.