com.amazonaws.services.costexplorer.model

Class GetCostCategoriesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.costexplorer.model.GetCostCategoriesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetCostCategoriesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetCostCategoriesRequest()

Method Summary

Modifier and Type	Method and Description
GetCostCategoriesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCostCategoryName()
Expression	getFilter()
Integer	getMaxResults() This field is only used when SortBy is provided in the request.
String	getNextPageToken() If the number of objects that are still available for retrieval exceeds the limit, AWS returns a NextPageToken value in the response.
String	getSearchString() The value that you want to search the filter values for.
List<SortDefinition>	getSortBy() The value by which you want to sort the data.
DateInterval	getTimePeriod()
int	hashCode()
void	setCostCategoryName(String costCategoryName)
void	setFilter(Expression filter)
void	setMaxResults(Integer maxResults) This field is only used when SortBy is provided in the request.
void	setNextPageToken(String nextPageToken) If the number of objects that are still available for retrieval exceeds the limit, AWS returns a NextPageToken value in the response.
void	setSearchString(String searchString) The value that you want to search the filter values for.
void	setSortBy(Collection<SortDefinition> sortBy) The value by which you want to sort the data.
void	setTimePeriod(DateInterval timePeriod)
String	toString() Returns a string representation of this object.
GetCostCategoriesRequest	withCostCategoryName(String costCategoryName)
GetCostCategoriesRequest	withFilter(Expression filter)
GetCostCategoriesRequest	withMaxResults(Integer maxResults) This field is only used when SortBy is provided in the request.
GetCostCategoriesRequest	withNextPageToken(String nextPageToken) If the number of objects that are still available for retrieval exceeds the limit, AWS returns a NextPageToken value in the response.
GetCostCategoriesRequest	withSearchString(String searchString) The value that you want to search the filter values for.
GetCostCategoriesRequest	withSortBy(Collection<SortDefinition> sortBy) The value by which you want to sort the data.
GetCostCategoriesRequest	withSortBy(SortDefinition... sortBy) The value by which you want to sort the data.
GetCostCategoriesRequest	withTimePeriod(DateInterval timePeriod)

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetCostCategoriesRequest

public GetCostCategoriesRequest()

Method Detail

setSearchString

public void setSearchString(String searchString)

The value that you want to search the filter values for.

If you do not specify a CostCategoryName, SearchString will be used to filter Cost Category names that match the SearchString pattern. If you do specifiy a CostCategoryName, SearchString will be used to filter Cost Category values that match the SearchString pattern.

Parameters:

searchString - The value that you want to search the filter values for.

If you do not specify a CostCategoryName, SearchString will be used to filter Cost Category names that match the SearchString pattern. If you do specifiy a CostCategoryName, SearchString will be used to filter Cost Category values that match the SearchString pattern.

getSearchString

public String getSearchString()

The value that you want to search the filter values for.

If you do not specify a CostCategoryName, SearchString will be used to filter Cost Category names that match the SearchString pattern. If you do specifiy a CostCategoryName, SearchString will be used to filter Cost Category values that match the SearchString pattern.

Returns:

The value that you want to search the filter values for.

If you do not specify a CostCategoryName, SearchString will be used to filter Cost Category names that match the SearchString pattern. If you do specifiy a CostCategoryName, SearchString will be used to filter Cost Category values that match the SearchString pattern.

withSearchString

public GetCostCategoriesRequest withSearchString(String searchString)

The value that you want to search the filter values for.

If you do not specify a CostCategoryName, SearchString will be used to filter Cost Category names that match the SearchString pattern. If you do specifiy a CostCategoryName, SearchString will be used to filter Cost Category values that match the SearchString pattern.

Parameters:

searchString - The value that you want to search the filter values for.

If you do not specify a CostCategoryName, SearchString will be used to filter Cost Category names that match the SearchString pattern. If you do specifiy a CostCategoryName, SearchString will be used to filter Cost Category values that match the SearchString pattern.

Returns:

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

setTimePeriod

public void setTimePeriod(DateInterval timePeriod)

Parameters:

timePeriod -

getTimePeriod

public DateInterval getTimePeriod()

Returns:

withTimePeriod

public GetCostCategoriesRequest withTimePeriod(DateInterval timePeriod)

Parameters:

timePeriod -

Returns:

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

setCostCategoryName

public void setCostCategoryName(String costCategoryName)

Parameters:

costCategoryName -

getCostCategoryName

public String getCostCategoryName()

Returns:

withCostCategoryName

public GetCostCategoriesRequest withCostCategoryName(String costCategoryName)

Parameters:

costCategoryName -

Returns:

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

setFilter

public void setFilter(Expression filter)

Parameters:

filter -

getFilter

public Expression getFilter()

Returns:

withFilter

public GetCostCategoriesRequest withFilter(Expression filter)

Parameters:

filter -

Returns:

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

getSortBy

public List<SortDefinition> getSortBy()

The value by which you want to sort the data.

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

• BlendedCost

• UnblendedCost

• AmortizedCost

• NetAmortizedCost

• NetUnblendedCost

• UsageQuantity

• NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When using SortBy, NextPageToken and SearchString are not supported.

Returns:

The value by which you want to sort the data.

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

• BlendedCost

• UnblendedCost

• AmortizedCost

• NetAmortizedCost

• NetUnblendedCost

• UsageQuantity

• NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When using SortBy, NextPageToken and SearchString are not supported.

setSortBy

public void setSortBy(Collection<SortDefinition> sortBy)

The value by which you want to sort the data.

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

• BlendedCost

• UnblendedCost

• AmortizedCost

• NetAmortizedCost

• NetUnblendedCost

• UsageQuantity

• NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When using SortBy, NextPageToken and SearchString are not supported.

Parameters:

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

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

• BlendedCost

• UnblendedCost

• AmortizedCost

• NetAmortizedCost

• NetUnblendedCost

• UsageQuantity

• NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When using SortBy, NextPageToken and SearchString are not supported.

withSortBy

public GetCostCategoriesRequest withSortBy(SortDefinition... sortBy)

The value by which you want to sort the data.

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

• BlendedCost

• UnblendedCost

• AmortizedCost

• NetAmortizedCost

• NetUnblendedCost

• UsageQuantity

• NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When using SortBy, NextPageToken and SearchString are not supported.

NOTE: This method appends the values to the existing list (if any). Use setSortBy(java.util.Collection) or withSortBy(java.util.Collection) if you want to override the existing values.

Parameters:

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

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

• BlendedCost

• UnblendedCost

• AmortizedCost

• NetAmortizedCost

• NetUnblendedCost

• UsageQuantity

• NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When using SortBy, NextPageToken and SearchString are not supported.

Returns:

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

withSortBy

public GetCostCategoriesRequest withSortBy(Collection<SortDefinition> sortBy)

The value by which you want to sort the data.

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

• BlendedCost

• UnblendedCost

• AmortizedCost

• NetAmortizedCost

• NetUnblendedCost

• UsageQuantity

• NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When using SortBy, NextPageToken and SearchString are not supported.

Parameters:

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

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

• BlendedCost

• UnblendedCost

• AmortizedCost

• NetAmortizedCost

• NetUnblendedCost

• UsageQuantity

• NormalizedUsageAmount

Supported values for SortOrder are ASCENDING or DESCENDING.

When using SortBy, NextPageToken and SearchString are not supported.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

This field is only used when SortBy is provided in the request.

The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

Parameters:

maxResults - This field is only used when SortBy is provided in the request.

The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

getMaxResults

public Integer getMaxResults()

This field is only used when SortBy is provided in the request.

The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

Returns:

This field is only used when SortBy is provided in the request.

The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

withMaxResults

public GetCostCategoriesRequest withMaxResults(Integer maxResults)

This field is only used when SortBy is provided in the request.

The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

Parameters:

maxResults - This field is only used when SortBy is provided in the request.

The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.

Returns:

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

setNextPageToken

public void setNextPageToken(String nextPageToken)

If the number of objects that are still available for retrieval exceeds the limit, AWS returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the prior call in your next request.

Parameters:

nextPageToken - If the number of objects that are still available for retrieval exceeds the limit, AWS returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the prior call in your next request.

getNextPageToken

public String getNextPageToken()

If the number of objects that are still available for retrieval exceeds the limit, AWS returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the prior call in your next request.

Returns:

If the number of objects that are still available for retrieval exceeds the limit, AWS returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the prior call in your next request.

withNextPageToken

public GetCostCategoriesRequest withNextPageToken(String nextPageToken)

If the number of objects that are still available for retrieval exceeds the limit, AWS returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the prior call in your next request.

Parameters:

nextPageToken - If the number of objects that are still available for retrieval exceeds the limit, AWS returns a NextPageToken value in the response. To retrieve the next batch of objects, provide the NextPageToken from the prior call in your next request.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetCostCategoriesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()