software.amazon.awssdk.services.costexplorer.model

Interface GetTagsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetTagsRequest.Builder,GetTagsRequest>, CostExplorerRequest.Builder, SdkBuilder<GetTagsRequest.Builder,GetTagsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetTagsRequest

public static interface GetTagsRequest.Builder
extends CostExplorerRequest.Builder, SdkPojo, CopyableBuilder<GetTagsRequest.Builder,GetTagsRequest>

Method Summary

Modifier and Type	Method and Description
default GetTagsRequest.Builder	filter(Consumer<Expression.Builder> filter) Sets the value of the Filter property for this object.
GetTagsRequest.Builder	filter(Expression filter) Sets the value of the Filter property for this object.
GetTagsRequest.Builder	maxResults(Integer maxResults) This field is only used when SortBy is provided in the request.
GetTagsRequest.Builder	nextPageToken(String nextPageToken) The token to retrieve the next set of results.
GetTagsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetTagsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetTagsRequest.Builder	searchString(String searchString) The value that you want to search for.
GetTagsRequest.Builder	sortBy(Collection<SortDefinition> sortBy) The value that you want to sort the data by.
GetTagsRequest.Builder	sortBy(Consumer<SortDefinition.Builder>... sortBy) The value that you want to sort the data by.
GetTagsRequest.Builder	sortBy(SortDefinition... sortBy) The value that you want to sort the data by.
GetTagsRequest.Builder	tagKey(String tagKey) The key of the tag that you want to return values for.
default GetTagsRequest.Builder	timePeriod(Consumer<DateInterval.Builder> timePeriod) The start and end dates for retrieving the dimension values.
GetTagsRequest.Builder	timePeriod(DateInterval timePeriod) The start and end dates for retrieving the dimension values.

Methods inherited from interface software.amazon.awssdk.services.costexplorer.model.CostExplorerRequest.Builder

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

searchString

GetTagsRequest.Builder searchString(String searchString)

The value that you want to search for.

Parameters:

searchString - The value that you want to search for.

Returns:

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

timePeriod

GetTagsRequest.Builder timePeriod(DateInterval timePeriod)

The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

Parameters:

timePeriod - The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

Returns:

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

timePeriod

default GetTagsRequest.Builder timePeriod(Consumer<DateInterval.Builder> timePeriod)

The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timePeriod(DateInterval).

Parameters:

timePeriod - a consumer that will call methods on DateInterval.Builder

Returns:

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

See Also:

timePeriod(DateInterval)

tagKey

GetTagsRequest.Builder tagKey(String tagKey)

The key of the tag that you want to return values for.

Parameters:

tagKey - The key of the tag that you want to return values for.

Returns:

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

filter

GetTagsRequest.Builder filter(Expression filter)

Sets the value of the Filter property for this object.

Parameters:

filter - The new value for the Filter property for this object.

Returns:

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

filter

default GetTagsRequest.Builder filter(Consumer<Expression.Builder> filter)

Sets the value of the Filter property for this object. This is a convenience method that creates an instance of the Expression.Builder avoiding the need to create one manually via Expression.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filter(Expression).

Parameters:

filter - a consumer that will call methods on Expression.Builder

Returns:

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

See Also:

filter(Expression)

sortBy

GetTagsRequest.Builder sortBy(Collection<SortDefinition> sortBy)

The value that you want to sort the data by.

The key represents cost and usage metrics. The following values are supported:

• BlendedCost

• UnblendedCost

• AmortizedCost

• NetAmortizedCost

• NetUnblendedCost

• UsageQuantity

• NormalizedUsageAmount

The supported values for SortOrder are ASCENDING and DESCENDING.

When you use SortBy, NextPageToken and SearchString aren't supported.

Parameters:

sortBy - The value that you want to sort the data by.

The key represents cost and usage metrics. The following values are supported:

• BlendedCost

• UnblendedCost

• AmortizedCost

• NetAmortizedCost

• NetUnblendedCost

• UsageQuantity

• NormalizedUsageAmount

The supported values for SortOrder are ASCENDING and DESCENDING .

When you use SortBy, NextPageToken and SearchString aren't supported.

Returns:

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

sortBy

GetTagsRequest.Builder sortBy(SortDefinition... sortBy)

The value that you want to sort the data by.

The key represents cost and usage metrics. The following values are supported:

• BlendedCost

• UnblendedCost

• AmortizedCost

• NetAmortizedCost

• NetUnblendedCost

• UsageQuantity

• NormalizedUsageAmount

The supported values for SortOrder are ASCENDING and DESCENDING.

When you use SortBy, NextPageToken and SearchString aren't supported.

Parameters:

sortBy - The value that you want to sort the data by.

The key represents cost and usage metrics. The following values are supported:

• BlendedCost

• UnblendedCost

• AmortizedCost

• NetAmortizedCost

• NetUnblendedCost

• UsageQuantity

• NormalizedUsageAmount

The supported values for SortOrder are ASCENDING and DESCENDING .

When you use SortBy, NextPageToken and SearchString aren't supported.

Returns:

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

sortBy

GetTagsRequest.Builder sortBy(Consumer<SortDefinition.Builder>... sortBy)

The value that you want to sort the data by.

The key represents cost and usage metrics. The following values are supported:

• BlendedCost

• UnblendedCost

• AmortizedCost

• NetAmortizedCost

• NetUnblendedCost

• UsageQuantity

• NormalizedUsageAmount

The supported values for SortOrder are ASCENDING and DESCENDING.

When you use SortBy, NextPageToken and SearchString aren't supported.

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

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

Parameters:

sortBy - a consumer that will call methods on SortDefinition.Builder

Returns:

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

See Also:

#sortBy(java.util.Collection)

maxResults

GetTagsRequest.Builder maxResults(Integer maxResults)

This field is only used when SortBy is provided in the request. The maximum number of objects that are returned for this request. If MaxResults isn't specified with SortBy, the request returns 1000 results as the default value for this parameter.

For GetTags, MaxResults has an upper quota of 1000.

Parameters:

maxResults - This field is only used when SortBy is provided in the request. The maximum number of objects that are returned for this request. If MaxResults isn't specified with SortBy, the request returns 1000 results as the default value for this parameter.

For GetTags, MaxResults has an upper quota of 1000.

Returns:

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

nextPageToken

GetTagsRequest.Builder nextPageToken(String nextPageToken)

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

Parameters:

nextPageToken - The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

Returns:

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

overrideConfiguration

GetTagsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder