software.amazon.awssdk.services.costexplorer.model

Class Expression

java.lang.Object

software.amazon.awssdk.services.costexplorer.model.Expression

All Implemented Interfaces:

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

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

Use Expression to filter by cost or by usage. There are two patterns:

• Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for INSTANCE_TYPE==m4.xlarge OR INSTANCE_TYPE==c4.large. The Expression for that looks like this:

  { "Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.xlarge", “c4.large” ] } }

  The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.

• Compound dimension values with logical operations - You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. This allows you to filter on more advanced options. For example, you can filter on ((INSTANCE_TYPE == m4.large OR INSTANCE_TYPE == m3.large) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that looks like this:

  { "And": [ {"Or": [ {"Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "m4.x.large", "c4.large" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }

  Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error.

  { "And": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Expression.Builder

Method Summary

Modifier and Type	Method and Description
List<Expression>	and() Return results that match both Dimension objects.
static Expression.Builder	builder()
DimensionValues	dimensions() The specific Dimension to use for Expression.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Expression	not() Return results that don't match a Dimension object.
List<Expression>	or() Return results that match either Dimension object.
List<SdkField<?>>	sdkFields()
static Class<? extends Expression.Builder>	serializableBuilderClass()
TagValues	tags() The specific Tag to use for Expression.
Expression.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

or

public List<Expression> or()

Return results that match either Dimension object.

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

Returns:

Return results that match either Dimension object.

and

public List<Expression> and()

Return results that match both Dimension objects.

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

Returns:

Return results that match both Dimension objects.

not

public Expression not()

Return results that don't match a Dimension object.

Returns:

Return results that don't match a Dimension object.

dimensions

public DimensionValues dimensions()

The specific Dimension to use for Expression.

Returns:

The specific Dimension to use for Expression.

tags

public TagValues tags()

The specific Tag to use for Expression.

Returns:

The specific Tag to use for Expression.

toBuilder

public Expression.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Expression.Builder,Expression>

Returns:

a builder for type T

builder

public static Expression.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.