Interface SummaryMetricQueryResult.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SummaryMetricQueryResult.Builder,SummaryMetricQueryResult>, SdkBuilder<SummaryMetricQueryResult.Builder,SummaryMetricQueryResult>, SdkPojo

Enclosing class:

SummaryMetricQueryResult

@Mutable
@NotThreadSafe
public static interface SummaryMetricQueryResult.Builder
extends SdkPojo, CopyableBuilder<SummaryMetricQueryResult.Builder,SummaryMetricQueryResult>

Method Summary

Modifier and Type	Method	Description
SummaryMetricQueryResult.Builder	aggregationPeriod(String aggregationPeriod)	The aggregation period of the metric.
SummaryMetricQueryResult.Builder	aggregationPeriod(AggregationPeriod aggregationPeriod)	The aggregation period of the metric.
SummaryMetricQueryResult.Builder	dimensions(Collection<Dimension> dimensions)	The dimensions of the metric.
SummaryMetricQueryResult.Builder	dimensions(Consumer<Dimension.Builder>... dimensions)	The dimensions of the metric.
SummaryMetricQueryResult.Builder	dimensions(Dimension... dimensions)	The dimensions of the metric.
SummaryMetricQueryResult.Builder	endTimestamp(Instant endTimestamp)	The end timestamp for the summary metric query.
SummaryMetricQueryResult.Builder	error(String error)	The error message for the summary metric query result.
SummaryMetricQueryResult.Builder	metricName(String metricName)	The name of the summary metric query result.
SummaryMetricQueryResult.Builder	metricName(MetricName metricName)	The name of the summary metric query result.
SummaryMetricQueryResult.Builder	queryId(String queryId)	The ID of the summary metric results query operation.
SummaryMetricQueryResult.Builder	queryStatus(String queryStatus)	The status of the summary metric query result.
SummaryMetricQueryResult.Builder	queryStatus(MetricQueryStatus queryStatus)	The status of the summary metric query result.
SummaryMetricQueryResult.Builder	startTimestamp(Instant startTimestamp)	The start timestamp for the summary metric query.
SummaryMetricQueryResult.Builder	timestamps(Instant... timestamps)	The timestamp of each aggregation result.
SummaryMetricQueryResult.Builder	timestamps(Collection<Instant> timestamps)	The timestamp of each aggregation result.
SummaryMetricQueryResult.Builder	unit(String unit)	The units of measurement to be used for interpreting the aggregation result.
SummaryMetricQueryResult.Builder	values(Collection<MetricQueryValue> values)	The list of aggregated summary metric query results.
SummaryMetricQueryResult.Builder	values(Consumer<MetricQueryValue.Builder>... values)	The list of aggregated summary metric query results.
SummaryMetricQueryResult.Builder	values(MetricQueryValue... values)	The list of aggregated summary metric query results.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

queryId

SummaryMetricQueryResult.Builder queryId(String queryId)

The ID of the summary metric results query operation.

Parameters:

queryId - The ID of the summary metric results query operation.

Returns:

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

queryStatus

SummaryMetricQueryResult.Builder queryStatus(String queryStatus)

The status of the summary metric query result.

Parameters:

queryStatus - The status of the summary metric query result.

Returns:

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

See Also:

• MetricQueryStatus
• MetricQueryStatus

queryStatus

SummaryMetricQueryResult.Builder queryStatus(MetricQueryStatus queryStatus)

The status of the summary metric query result.

Parameters:

queryStatus - The status of the summary metric query result.

Returns:

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

See Also:

• MetricQueryStatus
• MetricQueryStatus

error

SummaryMetricQueryResult.Builder error(String error)

The error message for the summary metric query result.

Parameters:

error - The error message for the summary metric query result.

Returns:

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

metricName

SummaryMetricQueryResult.Builder metricName(String metricName)

The name of the summary metric query result.

Parameters:

metricName - The name of the summary metric query result.

Returns:

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

See Also:

• MetricName
• MetricName

metricName

SummaryMetricQueryResult.Builder metricName(MetricName metricName)

The name of the summary metric query result.

Parameters:

metricName - The name of the summary metric query result.

Returns:

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

See Also:

• MetricName
• MetricName

dimensions

SummaryMetricQueryResult.Builder dimensions(Collection<Dimension> dimensions)

The dimensions of the metric.

Parameters:

dimensions - The dimensions of the metric.

Returns:

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

dimensions

SummaryMetricQueryResult.Builder dimensions(Dimension... dimensions)

The dimensions of the metric.

Parameters:

dimensions - The dimensions of the metric.

Returns:

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

dimensions

SummaryMetricQueryResult.Builder dimensions(Consumer<Dimension.Builder>... dimensions)

The dimensions of the metric.

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

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

Parameters:

dimensions - a consumer that will call methods on Dimension.Builder

Returns:

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

See Also:

• dimensions(java.util.Collection<Dimension>)

aggregationPeriod

SummaryMetricQueryResult.Builder aggregationPeriod(String aggregationPeriod)

The aggregation period of the metric.

Parameters:

aggregationPeriod - The aggregation period of the metric.

Returns:

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

See Also:

• AggregationPeriod
• AggregationPeriod

aggregationPeriod

SummaryMetricQueryResult.Builder aggregationPeriod(AggregationPeriod aggregationPeriod)

The aggregation period of the metric.

Parameters:

aggregationPeriod - The aggregation period of the metric.

Returns:

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

See Also:

• AggregationPeriod
• AggregationPeriod

startTimestamp

SummaryMetricQueryResult.Builder startTimestamp(Instant startTimestamp)

The start timestamp for the summary metric query.

Parameters:

startTimestamp - The start timestamp for the summary metric query.

Returns:

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

endTimestamp

SummaryMetricQueryResult.Builder endTimestamp(Instant endTimestamp)

The end timestamp for the summary metric query.

Parameters:

endTimestamp - The end timestamp for the summary metric query.

Returns:

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

timestamps

SummaryMetricQueryResult.Builder timestamps(Collection<Instant> timestamps)

The timestamp of each aggregation result.

Parameters:

timestamps - The timestamp of each aggregation result.

Returns:

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

timestamps

SummaryMetricQueryResult.Builder timestamps(Instant... timestamps)

The timestamp of each aggregation result.

Parameters:

timestamps - The timestamp of each aggregation result.

Returns:

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

values

SummaryMetricQueryResult.Builder values(Collection<MetricQueryValue> values)

The list of aggregated summary metric query results.

Parameters:

values - The list of aggregated summary metric query results.

Returns:

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

values

SummaryMetricQueryResult.Builder values(MetricQueryValue... values)

The list of aggregated summary metric query results.

Parameters:

values - The list of aggregated summary metric query results.

Returns:

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

values

SummaryMetricQueryResult.Builder values(Consumer<MetricQueryValue.Builder>... values)

The list of aggregated summary metric query results.

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

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

Parameters:

values - a consumer that will call methods on MetricQueryValue.Builder

Returns:

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

See Also:

• values(java.util.Collection<MetricQueryValue>)

unit

SummaryMetricQueryResult.Builder unit(String unit)

The units of measurement to be used for interpreting the aggregation result.

Parameters:

unit - The units of measurement to be used for interpreting the aggregation result.

Returns:

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