Expression (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.costexplorer.model.Expression

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Expression
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Use Expression to filter in various Cost Explorer APIs.

Not all Expression types are supported in each API. Refer to the documentation for each specific API to see what is supported.

There are two patterns:
- Simple dimension values.
  - There are three types of simple dimension values: CostCategories, Tags, and Dimensions.
    - Specify the CostCategories field to define a filter that acts on Cost Categories.
    - Specify the Tags field to define a filter that acts on Cost Allocation Tags.
    - Specify the Dimensions field to define a filter that acts on the DimensionValues .
  - For each filter type, you can set the dimension name and values for the filters that you plan to use.
    - For example, you can filter for REGION==us-east-1 OR REGION==us-west-1. For GetRightsizingRecommendation, the Region is a full name (for example, REGION==US East (N. Virginia).
    - The corresponding Expression for this example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] } }
    - As shown in the previous example, lists of dimension values are combined with OR when applying the filter.
  - You can also set different match options to further control how the filter behaves. Not all APIs support match options. Refer to the documentation for each specific API to see what is supported.
    - For example, you can filter for linked account names that start with "a".
    - The corresponding Expression for this example is as follows: { "Dimensions": { "Key": "LINKED_ACCOUNT_NAME", "MatchOptions": [ "STARTS_WITH" ], "Values": [ "a" ] } }
- Compound Expression types 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. By doing this, you can filter by more advanced options.
  - For example, you can filter by ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer).
  - The corresponding Expression for this example is as follows: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"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": [ ... ], "Dimensions": { "Key": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }
  
  The following is an example of the corresponding error message: "Expression has more than one roots. Only one root operator is allowed for each expression: And, Or, Not, Dimensions, Tags, CostCategories"
For the GetRightsizingRecommendation action, a combination of OR and NOT isn't supported. OR isn't supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE.

For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR aren't supported. Dimensions are limited to LINKED_ACCOUNT.
See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Expression()

Constructors
Constructor and Description
`Expression()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Expression`	`clone()`
`boolean`	`equals(Object obj)`
`List<Expression>`	`getAnd()` Return results that match both `Dimension` objects.
`CostCategoryValues`	`getCostCategories()` The filter that's based on `CostCategory` values.
`DimensionValues`	`getDimensions()` The specific `Dimension` to use for `Expression`.
`Expression`	`getNot()` Return results that don't match a `Dimension` object.
`List<Expression>`	`getOr()` Return results that match either `Dimension` object.
`TagValues`	`getTags()` The specific `Tag` to use for `Expression`.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAnd(Collection<Expression> and)` Return results that match both `Dimension` objects.
`void`	`setCostCategories(CostCategoryValues costCategories)` The filter that's based on `CostCategory` values.
`void`	`setDimensions(DimensionValues dimensions)` The specific `Dimension` to use for `Expression`.
`void`	`setNot(Expression not)` Return results that don't match a `Dimension` object.
`void`	`setOr(Collection<Expression> or)` Return results that match either `Dimension` object.
`void`	`setTags(TagValues tags)` The specific `Tag` to use for `Expression`.
`String`	`toString()` Returns a string representation of this object.
`Expression`	`withAnd(Collection<Expression> and)` Return results that match both `Dimension` objects.
`Expression`	`withAnd(Expression... and)` Return results that match both `Dimension` objects.
`Expression`	`withCostCategories(CostCategoryValues costCategories)` The filter that's based on `CostCategory` values.
`Expression`	`withDimensions(DimensionValues dimensions)` The specific `Dimension` to use for `Expression`.
`Expression`	`withNot(Expression not)` Return results that don't match a `Dimension` object.
`Expression`	`withOr(Collection<Expression> or)` Return results that match either `Dimension` object.
`Expression`	`withOr(Expression... or)` Return results that match either `Dimension` object.
`Expression`	`withTags(TagValues tags)` The specific `Tag` to use for `Expression`.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Expression
```
public Expression()
```
- Method Detail
  - getOr
```
public List<Expression> getOr()
```
    Return results that match either Dimension object.
    
    Returns:
    
    Return results that match either Dimension object.
  - setOr
```
public void setOr(Collection<Expression> or)
```
    Return results that match either Dimension object.
    
    Parameters:
    
    or - Return results that match either Dimension object.
  - withOr
```
public Expression withOr(Expression... or)
```
    Return results that match either Dimension object.
    
    NOTE: This method appends the values to the existing list (if any). Use setOr(java.util.Collection) or withOr(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    or - Return results that match either Dimension object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withOr
```
public Expression withOr(Collection<Expression> or)
```
    Return results that match either Dimension object.
    
    Parameters:
    
    or - Return results that match either Dimension object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAnd
```
public List<Expression> getAnd()
```
    Return results that match both Dimension objects.
    
    Returns:
    
    Return results that match both Dimension objects.
  - setAnd
```
public void setAnd(Collection<Expression> and)
```
    Return results that match both Dimension objects.
    
    Parameters:
    
    and - Return results that match both Dimension objects.
  - withAnd
```
public Expression withAnd(Expression... and)
```
    Return results that match both Dimension objects.
    
    NOTE: This method appends the values to the existing list (if any). Use setAnd(java.util.Collection) or withAnd(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    and - Return results that match both Dimension objects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAnd
```
public Expression withAnd(Collection<Expression> and)
```
    Return results that match both Dimension objects.
    
    Parameters:
    
    and - Return results that match both Dimension objects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNot
```
public void setNot(Expression not)
```
    Return results that don't match a Dimension object.
    
    Parameters:
    
    not - Return results that don't match a Dimension object.
  - getNot
```
public Expression getNot()
```
    Return results that don't match a Dimension object.
    
    Returns:
    
    Return results that don't match a Dimension object.
  - withNot
```
public Expression withNot(Expression not)
```
    Return results that don't match a Dimension object.
    
    Parameters:
    
    not - Return results that don't match a Dimension object.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDimensions
```
public void setDimensions(DimensionValues dimensions)
```
    The specific Dimension to use for Expression.
    
    Parameters:
    
    dimensions - The specific Dimension to use for Expression.
  - getDimensions
```
public DimensionValues getDimensions()
```
    The specific Dimension to use for Expression.
    
    Returns:
    
    The specific Dimension to use for Expression.
  - withDimensions
```
public Expression withDimensions(DimensionValues dimensions)
```
    The specific Dimension to use for Expression.
    
    Parameters:
    
    dimensions - The specific Dimension to use for Expression.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTags
```
public void setTags(TagValues tags)
```
    The specific Tag to use for Expression.
    
    Parameters:
    
    tags - The specific Tag to use for Expression.
  - getTags
```
public TagValues getTags()
```
    The specific Tag to use for Expression.
    
    Returns:
    
    The specific Tag to use for Expression.
  - withTags
```
public Expression withTags(TagValues tags)
```
    The specific Tag to use for Expression.
    
    Parameters:
    
    tags - The specific Tag to use for Expression.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCostCategories
```
public void setCostCategories(CostCategoryValues costCategories)
```
    The filter that's based on CostCategory values.
    
    Parameters:
    
    costCategories - The filter that's based on CostCategory values.
  - getCostCategories
```
public CostCategoryValues getCostCategories()
```
    The filter that's based on CostCategory values.
    
    Returns:
    
    The filter that's based on CostCategory values.
  - withCostCategories
```
public Expression withCostCategories(CostCategoryValues costCategories)
```
    The filter that's based on CostCategory values.
    
    Parameters:
    
    costCategories - The filter that's based on CostCategory values.
    
    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 Expression clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class Expression

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Expression

Method Detail

getOr

setOr

withOr

withOr

getAnd

setAnd

withAnd

withAnd

setNot

getNot

withNot

setDimensions

getDimensions

withDimensions

setTags

getTags

withTags

setCostCategories

getCostCategories

withCostCategories

toString

equals

hashCode

clone

marshall