software.amazon.awssdk.services.costexplorer.model

Class CostCategoryRule

java.lang.Object

software.amazon.awssdk.services.costexplorer.model.CostCategoryRule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CostCategoryRule.Builder,CostCategoryRule>

@Generated(value="software.amazon.awssdk:codegen")
public final class CostCategoryRule
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CostCategoryRule.Builder,CostCategoryRule>

Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CostCategoryRule.Builder

Method Summary

Modifier and Type	Method and Description
static CostCategoryRule.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
CostCategoryInheritedValueDimension	inheritedValue() The value the line item will be categorized as, if the line item contains the matched dimension.
Expression	rule() An Expression object used to categorize costs.
List<SdkField<?>>	sdkFields()
static Class<? extends CostCategoryRule.Builder>	serializableBuilderClass()
CostCategoryRule.Builder	toBuilder()
String	toString() Returns a string representation of this object.
CostCategoryRuleType	type() You can define the CostCategoryRule rule type as either REGULAR or INHERITED_VALUE.
String	typeAsString() You can define the CostCategoryRule rule type as either REGULAR or INHERITED_VALUE.
String	value() Returns the value of the Value property for this object.

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

value

public final String value()

Returns the value of the Value property for this object.

Returns:

The value of the Value property for this object.

rule

public final Expression rule()

An Expression object used to categorize costs. This supports dimensions, tags, and nested expressions. Currently the only dimensions supported are LINKED_ACCOUNT, SERVICE_CODE, RECORD_TYPE, and LINKED_ACCOUNT_NAME.

Root level OR is not supported. We recommend that you create a separate rule instead.

RECORD_TYPE is a dimension used for Cost Explorer APIs, and is also supported for Cost Category expressions. This dimension uses different terms, depending on whether you're using the console or API/JSON editor. For a detailed comparison, see Term Comparisons in the AWS Billing and Cost Management User Guide.

Returns:

An Expression object used to categorize costs. This supports dimensions, tags, and nested expressions. Currently the only dimensions supported are LINKED_ACCOUNT, SERVICE_CODE, RECORD_TYPE, and LINKED_ACCOUNT_NAME.

Root level OR is not supported. We recommend that you create a separate rule instead.

RECORD_TYPE is a dimension used for Cost Explorer APIs, and is also supported for Cost Category expressions. This dimension uses different terms, depending on whether you're using the console or API/JSON editor. For a detailed comparison, see Term Comparisons in the AWS Billing and Cost Management User Guide.

inheritedValue

public final CostCategoryInheritedValueDimension inheritedValue()

The value the line item will be categorized as, if the line item contains the matched dimension.

Returns:

The value the line item will be categorized as, if the line item contains the matched dimension.

type

public final CostCategoryRuleType type()

You can define the CostCategoryRule rule type as either REGULAR or INHERITED_VALUE. The INHERITED_VALUE rule type adds the flexibility of defining a rule that dynamically inherits the cost category value from the dimension value defined by CostCategoryInheritedValueDimension. For example, if you wanted to dynamically group costs based on the value of a specific tag key, you would first choose an inherited value rule type, then choose the tag dimension and specify the tag key to use.

If the service returns an enum value that is not available in the current SDK version, type will return CostCategoryRuleType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

You can define the CostCategoryRule rule type as either REGULAR or INHERITED_VALUE. The INHERITED_VALUE rule type adds the flexibility of defining a rule that dynamically inherits the cost category value from the dimension value defined by CostCategoryInheritedValueDimension. For example, if you wanted to dynamically group costs based on the value of a specific tag key, you would first choose an inherited value rule type, then choose the tag dimension and specify the tag key to use.

See Also:

CostCategoryRuleType

typeAsString

public final String typeAsString()

You can define the CostCategoryRule rule type as either REGULAR or INHERITED_VALUE. The INHERITED_VALUE rule type adds the flexibility of defining a rule that dynamically inherits the cost category value from the dimension value defined by CostCategoryInheritedValueDimension. For example, if you wanted to dynamically group costs based on the value of a specific tag key, you would first choose an inherited value rule type, then choose the tag dimension and specify the tag key to use.

If the service returns an enum value that is not available in the current SDK version, type will return CostCategoryRuleType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

You can define the CostCategoryRule rule type as either REGULAR or INHERITED_VALUE. The INHERITED_VALUE rule type adds the flexibility of defining a rule that dynamically inherits the cost category value from the dimension value defined by CostCategoryInheritedValueDimension. For example, if you wanted to dynamically group costs based on the value of a specific tag key, you would first choose an inherited value rule type, then choose the tag dimension and specify the tag key to use.

See Also:

CostCategoryRuleType

toBuilder

public CostCategoryRule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CostCategoryRule.Builder,CostCategoryRule>

builder

public static CostCategoryRule.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo