Interface GetCostCategoriesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetCostCategoriesRequest.Builder,
,GetCostCategoriesRequest> CostExplorerRequest.Builder
,SdkBuilder<GetCostCategoriesRequest.Builder,
,GetCostCategoriesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetCostCategoriesRequest
-
Method Summary
Modifier and TypeMethodDescriptioncostCategoryName
(String costCategoryName) Sets the value of the CostCategoryName property for this object.default GetCostCategoriesRequest.Builder
filter
(Consumer<Expression.Builder> filter) Sets the value of the Filter property for this object.filter
(Expression filter) Sets the value of the Filter property for this object.maxResults
(Integer maxResults) This field is only used when theSortBy
value is provided in the request.nextPageToken
(String nextPageToken) If the number of objects that are still available for retrieval exceeds the quota, Amazon Web Services returns a NextPageToken value in the response.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.searchString
(String searchString) The value that you want to search the filter values for.sortBy
(Collection<SortDefinition> sortBy) The value that you sort the data by.sortBy
(Consumer<SortDefinition.Builder>... sortBy) The value that you sort the data by.sortBy
(SortDefinition... sortBy) The value that you sort the data by.default GetCostCategoriesRequest.Builder
timePeriod
(Consumer<DateInterval.Builder> timePeriod) Sets the value of the TimePeriod property for this object.timePeriod
(DateInterval timePeriod) Sets the value of the TimePeriod property for this object.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.costexplorer.model.CostExplorerRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
searchString
The value that you want to search the filter values for.
If you don't specify a
CostCategoryName
,SearchString
is used to filter Cost Category names that match theSearchString
pattern. If you specify aCostCategoryName
,SearchString
is used to filter Cost Category values that match theSearchString
pattern.- Parameters:
searchString
- The value that you want to search the filter values for.If you don't specify a
CostCategoryName
,SearchString
is used to filter Cost Category names that match theSearchString
pattern. If you specify aCostCategoryName
,SearchString
is used to filter Cost Category values that match theSearchString
pattern.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
timePeriod
Sets the value of the TimePeriod property for this object.- Parameters:
timePeriod
- The new value for the TimePeriod property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
timePeriod
Sets the value of the TimePeriod property for this object. This is a convenience method that creates an instance of theDateInterval.Builder
avoiding the need to create one manually viaDateInterval.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totimePeriod(DateInterval)
.- Parameters:
timePeriod
- a consumer that will call methods onDateInterval.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
costCategoryName
Sets the value of the CostCategoryName property for this object.- Parameters:
costCategoryName
- The new value for the CostCategoryName property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
Sets the value of the Filter property for this object. This is a convenience method that creates an instance of theExpression.Builder
avoiding the need to create one manually viaExpression.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilter(Expression)
.- Parameters:
filter
- a consumer that will call methods onExpression.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sortBy
The value that you sort the data by.
The key represents the cost and usage metrics. The following values are supported:
-
BlendedCost
-
UnblendedCost
-
AmortizedCost
-
NetAmortizedCost
-
NetUnblendedCost
-
UsageQuantity
-
NormalizedUsageAmount
The supported key values for the
SortOrder
value areASCENDING
andDESCENDING
.When you use the
SortBy
value, theNextPageToken
andSearchString
key values aren't supported.- Parameters:
sortBy
- The value that you sort the data by.The key represents the cost and usage metrics. The following values are supported:
-
BlendedCost
-
UnblendedCost
-
AmortizedCost
-
NetAmortizedCost
-
NetUnblendedCost
-
UsageQuantity
-
NormalizedUsageAmount
The supported key values for the
SortOrder
value areASCENDING
andDESCENDING
.When you use the
SortBy
value, theNextPageToken
andSearchString
key values aren't supported.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
sortBy
The value that you sort the data by.
The key represents the cost and usage metrics. The following values are supported:
-
BlendedCost
-
UnblendedCost
-
AmortizedCost
-
NetAmortizedCost
-
NetUnblendedCost
-
UsageQuantity
-
NormalizedUsageAmount
The supported key values for the
SortOrder
value areASCENDING
andDESCENDING
.When you use the
SortBy
value, theNextPageToken
andSearchString
key values aren't supported.- Parameters:
sortBy
- The value that you sort the data by.The key represents the cost and usage metrics. The following values are supported:
-
BlendedCost
-
UnblendedCost
-
AmortizedCost
-
NetAmortizedCost
-
NetUnblendedCost
-
UsageQuantity
-
NormalizedUsageAmount
The supported key values for the
SortOrder
value areASCENDING
andDESCENDING
.When you use the
SortBy
value, theNextPageToken
andSearchString
key values aren't supported.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
sortBy
The value that you sort the data by.
The key represents the cost and usage metrics. The following values are supported:
-
BlendedCost
-
UnblendedCost
-
AmortizedCost
-
NetAmortizedCost
-
NetUnblendedCost
-
UsageQuantity
-
NormalizedUsageAmount
The supported key values for the
SortOrder
value areASCENDING
andDESCENDING
.When you use the
This is a convenience method that creates an instance of theSortBy
value, theNextPageToken
andSearchString
key values aren't supported.SortDefinition.Builder
avoiding the need to create one manually viaSortDefinition.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosortBy(List<SortDefinition>)
.- Parameters:
sortBy
- a consumer that will call methods onSortDefinition.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
maxResults
This field is only used when the
SortBy
value is provided in the request.The maximum number of objects that are returned for this request. If
MaxResults
isn't specified with theSortBy
value, the request returns 1000 results as the default value for this parameter.For
GetCostCategories
, MaxResults has an upper quota of 1000.- Parameters:
maxResults
- This field is only used when theSortBy
value is provided in the request.The maximum number of objects that are returned for this request. If
MaxResults
isn't specified with theSortBy
value, the request returns 1000 results as the default value for this parameter.For
GetCostCategories
, MaxResults has an upper quota of 1000.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextPageToken
If the number of objects that are still available for retrieval exceeds the quota, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the previous call in your next request.
- Parameters:
nextPageToken
- If the number of objects that are still available for retrieval exceeds the quota, Amazon Web Services returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the previous call in your next request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
GetCostCategoriesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetCostCategoriesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-