software.amazon.awssdk.services.cloudwatch.model

Interface GetMetricDataRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CloudWatchRequest.Builder, CopyableBuilder<GetMetricDataRequest.Builder,GetMetricDataRequest>, SdkBuilder<GetMetricDataRequest.Builder,GetMetricDataRequest>, SdkRequest.Builder

Enclosing class:

GetMetricDataRequest

public static interface GetMetricDataRequest.Builder
extends CloudWatchRequest.Builder, CopyableBuilder<GetMetricDataRequest.Builder,GetMetricDataRequest>

Method Summary

Modifier and Type	Method and Description
GetMetricDataRequest.Builder	endTime(Instant endTime) The time stamp indicating the latest data to be returned.
GetMetricDataRequest.Builder	maxDatapoints(Integer maxDatapoints) The maximum number of data points the request should return before paginating.
GetMetricDataRequest.Builder	metricDataQueries(Collection<MetricDataQuery> metricDataQueries) The metric queries to be returned.
GetMetricDataRequest.Builder	metricDataQueries(Consumer<MetricDataQuery.Builder>... metricDataQueries) The metric queries to be returned.
GetMetricDataRequest.Builder	metricDataQueries(MetricDataQuery... metricDataQueries) The metric queries to be returned.
GetMetricDataRequest.Builder	nextToken(String nextToken) Include this value, if it was returned by the previous call, to get the next set of data points.
GetMetricDataRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
GetMetricDataRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
GetMetricDataRequest.Builder	scanBy(ScanBy scanBy) The order in which data points should be returned.
GetMetricDataRequest.Builder	scanBy(String scanBy) The order in which data points should be returned.
GetMetricDataRequest.Builder	startTime(Instant startTime) The time stamp indicating the earliest data to be returned.

Methods inherited from interface software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

metricDataQueries

GetMetricDataRequest.Builder metricDataQueries(Collection<MetricDataQuery> metricDataQueries)

The metric queries to be returned. A single GetMetricData call can include as many as 100 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

Parameters:

metricDataQueries - The metric queries to be returned. A single GetMetricData call can include as many as 100 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

Returns:

Returns a reference to this object so that method calls can be chained together.

metricDataQueries

GetMetricDataRequest.Builder metricDataQueries(MetricDataQuery... metricDataQueries)

The metric queries to be returned. A single GetMetricData call can include as many as 100 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

Parameters:

metricDataQueries - The metric queries to be returned. A single GetMetricData call can include as many as 100 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

Returns:

Returns a reference to this object so that method calls can be chained together.

metricDataQueries

GetMetricDataRequest.Builder metricDataQueries(Consumer<MetricDataQuery.Builder>... metricDataQueries)

The metric queries to be returned. A single GetMetricData call can include as many as 100 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #metricDataQueries(List).

Parameters:

metricDataQueries - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#metricDataQueries(List)

startTime

GetMetricDataRequest.Builder startTime(Instant startTime)

The time stamp indicating the earliest data to be returned.

Parameters:

startTime - The time stamp indicating the earliest data to be returned.

Returns:

Returns a reference to this object so that method calls can be chained together.

endTime

GetMetricDataRequest.Builder endTime(Instant endTime)

The time stamp indicating the latest data to be returned.

Parameters:

endTime - The time stamp indicating the latest data to be returned.

Returns:

Returns a reference to this object so that method calls can be chained together.

nextToken

GetMetricDataRequest.Builder nextToken(String nextToken)

Include this value, if it was returned by the previous call, to get the next set of data points.

Parameters:

nextToken - Include this value, if it was returned by the previous call, to get the next set of data points.

Returns:

Returns a reference to this object so that method calls can be chained together.

scanBy

GetMetricDataRequest.Builder scanBy(String scanBy)

The order in which data points should be returned. TimestampDescending returns the newest data first and paginates when the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates when the MaxDatapoints limit is reached.

Parameters:

scanBy - The order in which data points should be returned. TimestampDescending returns the newest data first and paginates when the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates when the MaxDatapoints limit is reached.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScanBy, ScanBy

scanBy

GetMetricDataRequest.Builder scanBy(ScanBy scanBy)

The order in which data points should be returned. TimestampDescending returns the newest data first and paginates when the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates when the MaxDatapoints limit is reached.

Parameters:

scanBy - The order in which data points should be returned. TimestampDescending returns the newest data first and paginates when the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates when the MaxDatapoints limit is reached.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScanBy, ScanBy

maxDatapoints

GetMetricDataRequest.Builder maxDatapoints(Integer maxDatapoints)

The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.

Parameters:

maxDatapoints - The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

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

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