software.amazon.awssdk.services.costexplorer.model

Class GetTagsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.costexplorer.model.CostExplorerRequest

software.amazon.awssdk.services.costexplorer.model.GetTagsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetTagsRequest.Builder,GetTagsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetTagsRequest
extends CostExplorerRequest
implements ToCopyableBuilder<GetTagsRequest.Builder,GetTagsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetTagsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetTagsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Expression	filter() Returns the value of the Filter property for this object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSortBy() For responses, this returns true if the service returned a value for the SortBy property.
Integer	maxResults() This field is only used when SortBy is provided in the request.
String	nextPageToken() The token to retrieve the next set of results.
List<SdkField<?>>	sdkFields()
String	searchString() The value that you want to search for.
static Class<? extends GetTagsRequest.Builder>	serializableBuilderClass()
List<SortDefinition>	sortBy() The value that you want to sort the data by.
String	tagKey() The key of the tag that you want to return values for.
DateInterval	timePeriod() The start and end dates for retrieving the dimension values.
GetTagsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

searchString

public final String searchString()

The value that you want to search for.

Returns:

The value that you want to search for.

timePeriod

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

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.

tagKey

public final String tagKey()

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.

filter

public final Expression filter()

Returns the value of the Filter property for this object.

Returns:

The value of the Filter property for this object.

hasSortBy

public final boolean hasSortBy()

For responses, this returns true if the service returned a value for the SortBy property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

sortBy

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSortBy() method.

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.

maxResults

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

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.

nextPageToken

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

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.

toBuilder

public GetTagsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetTagsRequest.Builder,GetTagsRequest>

Specified by:

toBuilder in class CostExplorerRequest

builder

public static GetTagsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetTagsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo