Package software.amazon.awssdk.services.costexplorer.model

Class GetCostCategoriesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetCostCategoriesRequest.Builder,GetCostCategoriesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetCostCategoriesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetCostCategoriesRequest.Builder	builder()
String	costCategoryName()	Returns the value of the CostCategoryName property for this object.
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 the SortBy value is provided in the request.
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.
List<SdkField<?>>	sdkFields()
String	searchString()	The value that you want to search the filter values for.
static Class<? extends GetCostCategoriesRequest.Builder>	serializableBuilderClass()
List<SortDefinition>	sortBy()	The value that you sort the data by.
DateInterval	timePeriod()	Returns the value of the TimePeriod property for this object.
GetCostCategoriesRequest.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 the filter values for.

If you don't specify a CostCategoryName, SearchString is used to filter Cost Category names that match the SearchString pattern. If you specify a CostCategoryName, SearchString is 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 don't specify a CostCategoryName, SearchString is used to filter Cost Category names that match the SearchString pattern. If you specify a CostCategoryName, SearchString is used to filter Cost Category values that match the SearchString pattern.

timePeriod

public final DateInterval timePeriod()

Returns the value of the TimePeriod property for this object.

Returns:

The value of the TimePeriod property for this object.

costCategoryName

public final String costCategoryName()

Returns the value of the CostCategoryName property for this object.

Returns:

The value of the CostCategoryName property for this object.

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 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 are ASCENDING and DESCENDING.

When you use the SortBy value, the NextPageToken and SearchString key values 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 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 are ASCENDING and DESCENDING.

When you use the SortBy value, the NextPageToken and SearchString key values aren't supported.

maxResults

public final Integer 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 the SortBy value, the request returns 1000 results as the default value for this parameter.

For GetCostCategories, MaxResults has an upper quota of 1000.

Returns:

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 the SortBy value, the request returns 1000 results as the default value for this parameter.

For GetCostCategories, MaxResults has an upper quota of 1000.

nextPageToken

public final 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. To retrieve the next batch of objects, provide the NextPageToken from the previous call in your next request.

Returns:

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.

toBuilder

public GetCostCategoriesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetCostCategoriesRequest.Builder,GetCostCategoriesRequest>

Specified by:

toBuilder in class CostExplorerRequest

builder

public static GetCostCategoriesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetCostCategoriesRequest.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