Package software.amazon.awssdk.services.ec2.model

Interface GetCapacityManagerMetricDataRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetCapacityManagerMetricDataRequest.Builder,GetCapacityManagerMetricDataRequest>, Ec2Request.Builder, SdkBuilder<GetCapacityManagerMetricDataRequest.Builder,GetCapacityManagerMetricDataRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetCapacityManagerMetricDataRequest

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

Method Summary

Modifier and Type	Method	Description
GetCapacityManagerMetricDataRequest.Builder	dryRun(Boolean dryRun)	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
GetCapacityManagerMetricDataRequest.Builder	endTime(Instant endTime)	The end time for the metric data query, in ISO 8601 format.
GetCapacityManagerMetricDataRequest.Builder	filterBy(Collection<CapacityManagerCondition> filterBy)	Conditions to filter the metric data.
GetCapacityManagerMetricDataRequest.Builder	filterBy(Consumer<CapacityManagerCondition.Builder>... filterBy)	Conditions to filter the metric data.
GetCapacityManagerMetricDataRequest.Builder	filterBy(CapacityManagerCondition... filterBy)	Conditions to filter the metric data.
GetCapacityManagerMetricDataRequest.Builder	groupBy(Collection<GroupBy> groupBy)	The dimensions by which to group the metric data.
GetCapacityManagerMetricDataRequest.Builder	groupBy(GroupBy... groupBy)	The dimensions by which to group the metric data.
GetCapacityManagerMetricDataRequest.Builder	groupByWithStrings(String... groupBy)	The dimensions by which to group the metric data.
GetCapacityManagerMetricDataRequest.Builder	groupByWithStrings(Collection<String> groupBy)	The dimensions by which to group the metric data.
GetCapacityManagerMetricDataRequest.Builder	maxResults(Integer maxResults)	The maximum number of data points to return.
GetCapacityManagerMetricDataRequest.Builder	metricNames(Collection<Metric> metricNames)	The names of the metrics to retrieve.
GetCapacityManagerMetricDataRequest.Builder	metricNames(Metric... metricNames)	The names of the metrics to retrieve.
GetCapacityManagerMetricDataRequest.Builder	metricNamesWithStrings(String... metricNames)	The names of the metrics to retrieve.
GetCapacityManagerMetricDataRequest.Builder	metricNamesWithStrings(Collection<String> metricNames)	The names of the metrics to retrieve.
GetCapacityManagerMetricDataRequest.Builder	nextToken(String nextToken)	The token for the next page of results.
GetCapacityManagerMetricDataRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetCapacityManagerMetricDataRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetCapacityManagerMetricDataRequest.Builder	period(Integer period)	The granularity, in seconds, of the returned data points.
GetCapacityManagerMetricDataRequest.Builder	startTime(Instant startTime)	The start time for the metric data query, in ISO 8601 format.

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.services.ec2.model.Ec2Request.Builder

build

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 Detail

metricNamesWithStrings

GetCapacityManagerMetricDataRequest.Builder metricNamesWithStrings(Collection<String> metricNames)

The names of the metrics to retrieve. Maximum of 10 metrics per request.

Parameters:

metricNames - The names of the metrics to retrieve. Maximum of 10 metrics per request.

Returns:

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

metricNamesWithStrings

GetCapacityManagerMetricDataRequest.Builder metricNamesWithStrings(String... metricNames)

The names of the metrics to retrieve. Maximum of 10 metrics per request.

Parameters:

metricNames - The names of the metrics to retrieve. Maximum of 10 metrics per request.

Returns:

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

metricNames

GetCapacityManagerMetricDataRequest.Builder metricNames(Collection<Metric> metricNames)

The names of the metrics to retrieve. Maximum of 10 metrics per request.

Parameters:

metricNames - The names of the metrics to retrieve. Maximum of 10 metrics per request.

Returns:

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

metricNames

GetCapacityManagerMetricDataRequest.Builder metricNames(Metric... metricNames)

The names of the metrics to retrieve. Maximum of 10 metrics per request.

Parameters:

metricNames - The names of the metrics to retrieve. Maximum of 10 metrics per request.

Returns:

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

startTime

GetCapacityManagerMetricDataRequest.Builder startTime(Instant startTime)

The start time for the metric data query, in ISO 8601 format. The time range (end time - start time) must be a multiple of the specified period.

Parameters:

startTime - The start time for the metric data query, in ISO 8601 format. The time range (end time - start time) must be a multiple of the specified period.

Returns:

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

endTime

GetCapacityManagerMetricDataRequest.Builder endTime(Instant endTime)

The end time for the metric data query, in ISO 8601 format. If the end time is beyond the latest ingested data, it will be automatically adjusted to the latest available data point.

Parameters:

endTime - The end time for the metric data query, in ISO 8601 format. If the end time is beyond the latest ingested data, it will be automatically adjusted to the latest available data point.

Returns:

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

period

GetCapacityManagerMetricDataRequest.Builder period(Integer period)

The granularity, in seconds, of the returned data points.

Parameters:

period - The granularity, in seconds, of the returned data points.

Returns:

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

groupByWithStrings

GetCapacityManagerMetricDataRequest.Builder groupByWithStrings(Collection<String> groupBy)

The dimensions by which to group the metric data. This determines how the data is aggregated and returned.

Parameters:

groupBy - The dimensions by which to group the metric data. This determines how the data is aggregated and returned.

Returns:

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

groupByWithStrings

GetCapacityManagerMetricDataRequest.Builder groupByWithStrings(String... groupBy)

The dimensions by which to group the metric data. This determines how the data is aggregated and returned.

Parameters:

groupBy - The dimensions by which to group the metric data. This determines how the data is aggregated and returned.

Returns:

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

groupBy

GetCapacityManagerMetricDataRequest.Builder groupBy(Collection<GroupBy> groupBy)

The dimensions by which to group the metric data. This determines how the data is aggregated and returned.

Parameters:

groupBy - The dimensions by which to group the metric data. This determines how the data is aggregated and returned.

Returns:

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

groupBy

GetCapacityManagerMetricDataRequest.Builder groupBy(GroupBy... groupBy)

The dimensions by which to group the metric data. This determines how the data is aggregated and returned.

Parameters:

groupBy - The dimensions by which to group the metric data. This determines how the data is aggregated and returned.

Returns:

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

filterBy

GetCapacityManagerMetricDataRequest.Builder filterBy(Collection<CapacityManagerCondition> filterBy)

Conditions to filter the metric data. Each filter specifies a dimension, comparison operator ('equals', 'in'), and values to match against.

Parameters:

filterBy - Conditions to filter the metric data. Each filter specifies a dimension, comparison operator ('equals', 'in'), and values to match against.

Returns:

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

filterBy

GetCapacityManagerMetricDataRequest.Builder filterBy(CapacityManagerCondition... filterBy)

Conditions to filter the metric data. Each filter specifies a dimension, comparison operator ('equals', 'in'), and values to match against.

Parameters:

filterBy - Conditions to filter the metric data. Each filter specifies a dimension, comparison operator ('equals', 'in'), and values to match against.

Returns:

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

filterBy

GetCapacityManagerMetricDataRequest.Builder filterBy(Consumer<CapacityManagerCondition.Builder>... filterBy)

Conditions to filter the metric data. Each filter specifies a dimension, comparison operator ('equals', 'in'), and values to match against.

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

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

Parameters:

filterBy - a consumer that will call methods on CapacityManagerCondition.Builder

Returns:

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

See Also:

#filterBy(java.util.Collection)

maxResults

GetCapacityManagerMetricDataRequest.Builder maxResults(Integer maxResults)

The maximum number of data points to return. Valid range is 1 to 100,000. Use with NextToken for pagination of large result sets.

Parameters:

maxResults - The maximum number of data points to return. Valid range is 1 to 100,000. Use with NextToken for pagination of large result sets.

Returns:

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

nextToken

GetCapacityManagerMetricDataRequest.Builder nextToken(String nextToken)

The token for the next page of results. Use this value in a subsequent call to retrieve additional data points.

Parameters:

nextToken - The token for the next page of results. Use this value in a subsequent call to retrieve additional data points.

Returns:

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

dryRun

GetCapacityManagerMetricDataRequest.Builder dryRun(Boolean dryRun)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Parameters:

dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

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

overrideConfiguration

GetCapacityManagerMetricDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

GetCapacityManagerMetricDataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder