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

Interface GetCapacityManagerMetricDimensionsRequest.Builder

All Superinterfaces:

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

Enclosing class:

GetCapacityManagerMetricDimensionsRequest

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

Method Summary

Modifier and Type	Method	Description
GetCapacityManagerMetricDimensionsRequest.Builder	dryRun(Boolean dryRun)	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
GetCapacityManagerMetricDimensionsRequest.Builder	endTime(Instant endTime)	The end time for the dimension query, in ISO 8601 format.
GetCapacityManagerMetricDimensionsRequest.Builder	filterBy(Collection<CapacityManagerCondition> filterBy)	Conditions to filter which dimension values are returned.
GetCapacityManagerMetricDimensionsRequest.Builder	filterBy(Consumer<CapacityManagerCondition.Builder>... filterBy)	Conditions to filter which dimension values are returned.
GetCapacityManagerMetricDimensionsRequest.Builder	filterBy(CapacityManagerCondition... filterBy)	Conditions to filter which dimension values are returned.
GetCapacityManagerMetricDimensionsRequest.Builder	groupBy(Collection<GroupBy> groupBy)	The dimensions to group by when retrieving available dimension values.
GetCapacityManagerMetricDimensionsRequest.Builder	groupBy(GroupBy... groupBy)	The dimensions to group by when retrieving available dimension values.
GetCapacityManagerMetricDimensionsRequest.Builder	groupByWithStrings(String... groupBy)	The dimensions to group by when retrieving available dimension values.
GetCapacityManagerMetricDimensionsRequest.Builder	groupByWithStrings(Collection<String> groupBy)	The dimensions to group by when retrieving available dimension values.
GetCapacityManagerMetricDimensionsRequest.Builder	maxResults(Integer maxResults)	The maximum number of dimension combinations to return.
GetCapacityManagerMetricDimensionsRequest.Builder	metricNames(Collection<Metric> metricNames)	The metric names to use as an additional filter when retrieving dimensions.
GetCapacityManagerMetricDimensionsRequest.Builder	metricNames(Metric... metricNames)	The metric names to use as an additional filter when retrieving dimensions.
GetCapacityManagerMetricDimensionsRequest.Builder	metricNamesWithStrings(String... metricNames)	The metric names to use as an additional filter when retrieving dimensions.
GetCapacityManagerMetricDimensionsRequest.Builder	metricNamesWithStrings(Collection<String> metricNames)	The metric names to use as an additional filter when retrieving dimensions.
GetCapacityManagerMetricDimensionsRequest.Builder	nextToken(String nextToken)	The token for the next page of results.
GetCapacityManagerMetricDimensionsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetCapacityManagerMetricDimensionsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetCapacityManagerMetricDimensionsRequest.Builder	startTime(Instant startTime)	The start time for the dimension 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

groupByWithStrings

GetCapacityManagerMetricDimensionsRequest.Builder groupByWithStrings(Collection<String> groupBy)

The dimensions to group by when retrieving available dimension values. This determines which dimension combinations are returned. Required parameter.

Parameters:

groupBy - The dimensions to group by when retrieving available dimension values. This determines which dimension combinations are returned. Required parameter.

Returns:

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

groupByWithStrings

GetCapacityManagerMetricDimensionsRequest.Builder groupByWithStrings(String... groupBy)

The dimensions to group by when retrieving available dimension values. This determines which dimension combinations are returned. Required parameter.

Parameters:

groupBy - The dimensions to group by when retrieving available dimension values. This determines which dimension combinations are returned. Required parameter.

Returns:

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

groupBy

GetCapacityManagerMetricDimensionsRequest.Builder groupBy(Collection<GroupBy> groupBy)

The dimensions to group by when retrieving available dimension values. This determines which dimension combinations are returned. Required parameter.

Parameters:

groupBy - The dimensions to group by when retrieving available dimension values. This determines which dimension combinations are returned. Required parameter.

Returns:

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

groupBy

GetCapacityManagerMetricDimensionsRequest.Builder groupBy(GroupBy... groupBy)

The dimensions to group by when retrieving available dimension values. This determines which dimension combinations are returned. Required parameter.

Parameters:

groupBy - The dimensions to group by when retrieving available dimension values. This determines which dimension combinations are returned. Required parameter.

Returns:

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

filterBy

GetCapacityManagerMetricDimensionsRequest.Builder filterBy(Collection<CapacityManagerCondition> filterBy)

Conditions to filter which dimension values are returned. Each filter specifies a dimension, comparison operator, and values to match against.

Parameters:

filterBy - Conditions to filter which dimension values are returned. Each filter specifies a dimension, comparison operator, and values to match against.

Returns:

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

filterBy

GetCapacityManagerMetricDimensionsRequest.Builder filterBy(CapacityManagerCondition... filterBy)

Conditions to filter which dimension values are returned. Each filter specifies a dimension, comparison operator, and values to match against.

Parameters:

filterBy - Conditions to filter which dimension values are returned. Each filter specifies a dimension, comparison operator, and values to match against.

Returns:

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

filterBy

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

Conditions to filter which dimension values are returned. Each filter specifies a dimension, comparison operator, 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)

startTime

GetCapacityManagerMetricDimensionsRequest.Builder startTime(Instant startTime)

The start time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.

Parameters:

startTime - The start time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.

Returns:

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

endTime

GetCapacityManagerMetricDimensionsRequest.Builder endTime(Instant endTime)

The end time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.

Parameters:

endTime - The end time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.

Returns:

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

metricNamesWithStrings

GetCapacityManagerMetricDimensionsRequest.Builder metricNamesWithStrings(Collection<String> metricNames)

The metric names to use as an additional filter when retrieving dimensions. Only dimensions that have data for these metrics will be returned. Required parameter with maximum size of 1 for v1.

Parameters:

metricNames - The metric names to use as an additional filter when retrieving dimensions. Only dimensions that have data for these metrics will be returned. Required parameter with maximum size of 1 for v1.

Returns:

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

metricNamesWithStrings

GetCapacityManagerMetricDimensionsRequest.Builder metricNamesWithStrings(String... metricNames)

The metric names to use as an additional filter when retrieving dimensions. Only dimensions that have data for these metrics will be returned. Required parameter with maximum size of 1 for v1.

Parameters:

metricNames - The metric names to use as an additional filter when retrieving dimensions. Only dimensions that have data for these metrics will be returned. Required parameter with maximum size of 1 for v1.

Returns:

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

metricNames

GetCapacityManagerMetricDimensionsRequest.Builder metricNames(Collection<Metric> metricNames)

The metric names to use as an additional filter when retrieving dimensions. Only dimensions that have data for these metrics will be returned. Required parameter with maximum size of 1 for v1.

Parameters:

metricNames - The metric names to use as an additional filter when retrieving dimensions. Only dimensions that have data for these metrics will be returned. Required parameter with maximum size of 1 for v1.

Returns:

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

metricNames

GetCapacityManagerMetricDimensionsRequest.Builder metricNames(Metric... metricNames)

The metric names to use as an additional filter when retrieving dimensions. Only dimensions that have data for these metrics will be returned. Required parameter with maximum size of 1 for v1.

Parameters:

metricNames - The metric names to use as an additional filter when retrieving dimensions. Only dimensions that have data for these metrics will be returned. Required parameter with maximum size of 1 for v1.

Returns:

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

maxResults

GetCapacityManagerMetricDimensionsRequest.Builder maxResults(Integer maxResults)

The maximum number of dimension combinations to return. Valid range is 1 to 1000. Use with NextToken for pagination.

Parameters:

maxResults - The maximum number of dimension combinations to return. Valid range is 1 to 1000. Use with NextToken for pagination.

Returns:

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

nextToken

GetCapacityManagerMetricDimensionsRequest.Builder nextToken(String nextToken)

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

Parameters:

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

Returns:

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

dryRun

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

GetCapacityManagerMetricDimensionsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder