com.amazonaws.services.costexplorer.model

Class GetTagsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.costexplorer.model.GetTagsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetTagsRequest
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
GetTagsRequest()

Method Summary

Modifier and Type	Method and Description
GetTagsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Expression	getFilter()
Integer	getMaxResults() This field is only used when SortBy is provided in the request.
String	getNextPageToken() The token to retrieve the next set of results.
String	getSearchString() The value that you want to search for.
List<SortDefinition>	getSortBy() The value that you want to sort the data by.
String	getTagKey() The key of the tag that you want to return values for.
DateInterval	getTimePeriod() The start and end dates for retrieving the dimension values.
int	hashCode()
void	setFilter(Expression filter)
void	setMaxResults(Integer maxResults) This field is only used when SortBy is provided in the request.
void	setNextPageToken(String nextPageToken) The token to retrieve the next set of results.
void	setSearchString(String searchString) The value that you want to search for.
void	setSortBy(Collection<SortDefinition> sortBy) The value that you want to sort the data by.
void	setTagKey(String tagKey) The key of the tag that you want to return values for.
void	setTimePeriod(DateInterval timePeriod) The start and end dates for retrieving the dimension values.
String	toString() Returns a string representation of this object.
GetTagsRequest	withFilter(Expression filter)
GetTagsRequest	withMaxResults(Integer maxResults) This field is only used when SortBy is provided in the request.
GetTagsRequest	withNextPageToken(String nextPageToken) The token to retrieve the next set of results.
GetTagsRequest	withSearchString(String searchString) The value that you want to search for.
GetTagsRequest	withSortBy(Collection<SortDefinition> sortBy) The value that you want to sort the data by.
GetTagsRequest	withSortBy(SortDefinition... sortBy) The value that you want to sort the data by.
GetTagsRequest	withTagKey(String tagKey) The key of the tag that you want to return values for.
GetTagsRequest	withTimePeriod(DateInterval timePeriod) The start and end dates for retrieving the dimension values.

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

GetTagsRequest

public GetTagsRequest()

Method Detail

setSearchString

public void setSearchString(String searchString)

The value that you want to search for.

Parameters:

searchString - The value that you want to search for.

getSearchString

public String getSearchString()

The value that you want to search for.

Returns:

The value that you want to search for.

withSearchString

public GetTagsRequest withSearchString(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.

setTimePeriod

public void setTimePeriod(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.

getTimePeriod

public DateInterval getTimePeriod()

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:

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.

withTimePeriod

public GetTagsRequest withTimePeriod(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.

setTagKey

public void setTagKey(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.

getTagKey

public String getTagKey()

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

Returns:

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

withTagKey

public GetTagsRequest withTagKey(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.

setFilter

public void setFilter(Expression filter)

Parameters:

filter -

getFilter

public Expression getFilter()

Returns:

withFilter

public GetTagsRequest 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 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:

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.

setSortBy

public void setSortBy(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.

withSortBy

public GetTagsRequest withSortBy(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.

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

withSortBy

public GetTagsRequest withSortBy(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.

setMaxResults

public void setMaxResults(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.

getMaxResults

public Integer getMaxResults()

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:

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.

withMaxResults

public GetTagsRequest withMaxResults(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.

setNextPageToken

public void setNextPageToken(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.

getNextPageToken

public String getNextPageToken()

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:

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.

withNextPageToken

public GetTagsRequest withNextPageToken(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.

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 GetTagsRequest 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()