software.amazon.awssdk.services.costexplorer.model.Expression Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of costexplorer Show documentation
Show all versions of costexplorer Show documentation
The AWS Java SDK for AWS Cost Explorer module holds the client classes that are used for communicating
with AWS Cost Explorer Service
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.costexplorer.model;
import java.beans.Transient;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* 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 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 Expression example looks like:
*
*
* { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } }
*
*
* 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
* ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer).
* The Expression for that looks like this:
*
*
* { "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": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }
*
*
*
*
*
* For the GetRightsizingRecommendation action, a combination of OR and NOT is not supported. OR is not
* 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 are not
* supported. Dimensions are limited to LINKED_ACCOUNT.
*
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Expression implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> OR_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Or")
.getter(getter(Expression::or))
.setter(setter(Builder::or))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Or").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Expression::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> AND_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("And")
.getter(getter(Expression::and))
.setter(setter(Builder::and))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("And").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Expression::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField NOT_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Not").getter(getter(Expression::not)).setter(setter(Builder::not)).constructor(Expression::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Not").build()).build();
private static final SdkField DIMENSIONS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Dimensions").getter(getter(Expression::dimensions))
.setter(setter(Builder::dimensions)).constructor(DimensionValues::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Dimensions").build()).build();
private static final SdkField TAGS_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Tags").getter(getter(Expression::tags)).setter(setter(Builder::tags)).constructor(TagValues::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build()).build();
private static final SdkField COST_CATEGORIES_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("CostCategories")
.getter(getter(Expression::costCategories)).setter(setter(Builder::costCategories))
.constructor(CostCategoryValues::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CostCategories").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(OR_FIELD, AND_FIELD,
NOT_FIELD, DIMENSIONS_FIELD, TAGS_FIELD, COST_CATEGORIES_FIELD));
private static final long serialVersionUID = 1L;
private final List or;
private final List and;
private final Expression not;
private final DimensionValues dimensions;
private final TagValues tags;
private final CostCategoryValues costCategories;
private Expression(BuilderImpl builder) {
this.or = builder.or;
this.and = builder.and;
this.not = builder.not;
this.dimensions = builder.dimensions;
this.tags = builder.tags;
this.costCategories = builder.costCategories;
}
/**
* Returns true if the Or property was specified by the sender (it may be empty), or false if the sender did not
* specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasOr() {
return or != null && !(or instanceof SdkAutoConstructList);
}
/**
*
* Return results that match either Dimension object.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasOr()} to see if a value was sent in this field.
*
*
* @return Return results that match either Dimension object.
*/
public final List or() {
return or;
}
/**
* Returns true if the And property was specified by the sender (it may be empty), or false if the sender did not
* specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasAnd() {
return and != null && !(and instanceof SdkAutoConstructList);
}
/**
*
* Return results that match both Dimension objects.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasAnd()} to see if a value was sent in this field.
*
*
* @return Return results that match both Dimension objects.
*/
public final List and() {
return and;
}
/**
*
* Return results that don't match a Dimension object.
*
*
* @return Return results that don't match a Dimension object.
*/
public final Expression not() {
return not;
}
/**
*
* The specific Dimension to use for Expression.
*
*
* @return The specific Dimension to use for Expression.
*/
public final DimensionValues dimensions() {
return dimensions;
}
/**
*
* The specific Tag to use for Expression.
*
*
* @return The specific Tag to use for Expression.
*/
public final TagValues tags() {
return tags;
}
/**
*
* The filter based on CostCategory values.
*
*
* @return The filter based on CostCategory values.
*/
public final CostCategoryValues costCategories() {
return costCategories;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(hasOr() ? or() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasAnd() ? and() : null);
hashCode = 31 * hashCode + Objects.hashCode(not());
hashCode = 31 * hashCode + Objects.hashCode(dimensions());
hashCode = 31 * hashCode + Objects.hashCode(tags());
hashCode = 31 * hashCode + Objects.hashCode(costCategories());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof Expression)) {
return false;
}
Expression other = (Expression) obj;
return hasOr() == other.hasOr() && Objects.equals(or(), other.or()) && hasAnd() == other.hasAnd()
&& Objects.equals(and(), other.and()) && Objects.equals(not(), other.not())
&& Objects.equals(dimensions(), other.dimensions()) && Objects.equals(tags(), other.tags())
&& Objects.equals(costCategories(), other.costCategories());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("Expression").add("Or", hasOr() ? or() : null).add("And", hasAnd() ? and() : null)
.add("Not", not()).add("Dimensions", dimensions()).add("Tags", tags()).add("CostCategories", costCategories())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Or":
return Optional.ofNullable(clazz.cast(or()));
case "And":
return Optional.ofNullable(clazz.cast(and()));
case "Not":
return Optional.ofNullable(clazz.cast(not()));
case "Dimensions":
return Optional.ofNullable(clazz.cast(dimensions()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
case "CostCategories":
return Optional.ofNullable(clazz.cast(costCategories()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Expression) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Return results that match either Dimension object.
*
*
* @param or
* Return results that match either Dimension object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder or(Collection or);
/**
*
* Return results that match either Dimension object.
*
*
* @param or
* Return results that match either Dimension object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder or(Expression... or);
/**
*
* Return results that match either Dimension object.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to
* create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its
* result is passed to {@link #or(List)}.
*
* @param or
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #or(List)
*/
Builder or(Consumer... or);
/**
*
* Return results that match both Dimension objects.
*
*
* @param and
* Return results that match both Dimension objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder and(Collection and);
/**
*
* Return results that match both Dimension objects.
*
*
* @param and
* Return results that match both Dimension objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder and(Expression... and);
/**
*
* Return results that match both Dimension objects.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need to
* create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its
* result is passed to {@link #and(List)}.
*
* @param and
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #and(List)
*/
Builder and(Consumer... and);
/**
*
* Return results that don't match a Dimension object.
*
*
* @param not
* Return results that don't match a Dimension object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder not(Expression not);
/**
*
* Return results that don't match a Dimension object.
*
* This is a convenience that creates an instance of the {@link Expression.Builder} avoiding the need to create
* one manually via {@link Expression#builder()}.
*
* When the {@link Consumer} completes, {@link Expression.Builder#build()} is called immediately and its result
* is passed to {@link #not(Expression)}.
*
* @param not
* a consumer that will call methods on {@link Expression.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #not(Expression)
*/
default Builder not(Consumer not) {
return not(Expression.builder().applyMutation(not).build());
}
/**
*
* The specific Dimension to use for Expression.
*
*
* @param dimensions
* The specific Dimension to use for Expression.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dimensions(DimensionValues dimensions);
/**
*
* The specific Dimension to use for Expression.
*
* This is a convenience that creates an instance of the {@link DimensionValues.Builder} avoiding the need to
* create one manually via {@link DimensionValues#builder()}.
*
* When the {@link Consumer} completes, {@link DimensionValues.Builder#build()} is called immediately and its
* result is passed to {@link #dimensions(DimensionValues)}.
*
* @param dimensions
* a consumer that will call methods on {@link DimensionValues.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #dimensions(DimensionValues)
*/
default Builder dimensions(Consumer dimensions) {
return dimensions(DimensionValues.builder().applyMutation(dimensions).build());
}
/**
*
* The specific Tag to use for Expression.
*
*
* @param tags
* The specific Tag to use for Expression.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(TagValues tags);
/**
*
* The specific Tag to use for Expression.
*
* This is a convenience that creates an instance of the {@link TagValues.Builder} avoiding the need to create
* one manually via {@link TagValues#builder()}.
*
* When the {@link Consumer} completes, {@link TagValues.Builder#build()} is called immediately and its result
* is passed to {@link #tags(TagValues)}.
*
* @param tags
* a consumer that will call methods on {@link TagValues.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(TagValues)
*/
default Builder tags(Consumer tags) {
return tags(TagValues.builder().applyMutation(tags).build());
}
/**
*
* The filter based on CostCategory values.
*
*
* @param costCategories
* The filter based on CostCategory values.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder costCategories(CostCategoryValues costCategories);
/**
*
* The filter based on CostCategory values.
*
* This is a convenience that creates an instance of the {@link CostCategoryValues.Builder} avoiding the need to
* create one manually via {@link CostCategoryValues#builder()}.
*
* When the {@link Consumer} completes, {@link CostCategoryValues.Builder#build()} is called immediately and its
* result is passed to {@link #costCategories(CostCategoryValues)}.
*
* @param costCategories
* a consumer that will call methods on {@link CostCategoryValues.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #costCategories(CostCategoryValues)
*/
default Builder costCategories(Consumer costCategories) {
return costCategories(CostCategoryValues.builder().applyMutation(costCategories).build());
}
}
static final class BuilderImpl implements Builder {
private List or = DefaultSdkAutoConstructList.getInstance();
private List and = DefaultSdkAutoConstructList.getInstance();
private Expression not;
private DimensionValues dimensions;
private TagValues tags;
private CostCategoryValues costCategories;
private BuilderImpl() {
}
private BuilderImpl(Expression model) {
or(model.or);
and(model.and);
not(model.not);
dimensions(model.dimensions);
tags(model.tags);
costCategories(model.costCategories);
}
public final List getOr() {
List result = ExpressionsCopier.copyToBuilder(this.or);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setOr(Collection or) {
this.or = ExpressionsCopier.copyFromBuilder(or);
}
@Override
@Transient
public final Builder or(Collection or) {
this.or = ExpressionsCopier.copy(or);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder or(Expression... or) {
or(Arrays.asList(or));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder or(Consumer... or) {
or(Stream.of(or).map(c -> Expression.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final List getAnd() {
List result = ExpressionsCopier.copyToBuilder(this.and);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setAnd(Collection and) {
this.and = ExpressionsCopier.copyFromBuilder(and);
}
@Override
@Transient
public final Builder and(Collection and) {
this.and = ExpressionsCopier.copy(and);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder and(Expression... and) {
and(Arrays.asList(and));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder and(Consumer... and) {
and(Stream.of(and).map(c -> Expression.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final Builder getNot() {
return not != null ? not.toBuilder() : null;
}
public final void setNot(BuilderImpl not) {
this.not = not != null ? not.build() : null;
}
@Override
@Transient
public final Builder not(Expression not) {
this.not = not;
return this;
}
public final DimensionValues.Builder getDimensions() {
return dimensions != null ? dimensions.toBuilder() : null;
}
public final void setDimensions(DimensionValues.BuilderImpl dimensions) {
this.dimensions = dimensions != null ? dimensions.build() : null;
}
@Override
@Transient
public final Builder dimensions(DimensionValues dimensions) {
this.dimensions = dimensions;
return this;
}
public final TagValues.Builder getTags() {
return tags != null ? tags.toBuilder() : null;
}
public final void setTags(TagValues.BuilderImpl tags) {
this.tags = tags != null ? tags.build() : null;
}
@Override
@Transient
public final Builder tags(TagValues tags) {
this.tags = tags;
return this;
}
public final CostCategoryValues.Builder getCostCategories() {
return costCategories != null ? costCategories.toBuilder() : null;
}
public final void setCostCategories(CostCategoryValues.BuilderImpl costCategories) {
this.costCategories = costCategories != null ? costCategories.build() : null;
}
@Override
@Transient
public final Builder costCategories(CostCategoryValues costCategories) {
this.costCategories = costCategories;
return this;
}
@Override
public Expression build() {
return new Expression(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy