Package software.amazon.awssdk.services.billingconductor.model

Class LineItemFilter

java.lang.Object

software.amazon.awssdk.services.billingconductor.model.LineItemFilter

All Implemented Interfaces:

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

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

A representation of the line item filter for your custom line item. You can use line item filters to include or exclude specific resource values from the billing group's total cost. For example, if you create a custom line item and you want to filter out a value, such as Savings Plan discounts, you can update LineItemFilter to exclude it.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LineItemFilter.Builder

Method Summary

Modifier and Type	Method	Description
LineItemFilterAttributeName	attribute()	The attribute of the line item filter.
String	attributeAsString()	The attribute of the line item filter.
static LineItemFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues()	For responses, this returns true if the service returned a value for the Values property.
MatchOption	matchOption()	The match criteria of the line item filter.
String	matchOptionAsString()	The match criteria of the line item filter.
List<SdkField<?>>	sdkFields()
static Class<? extends LineItemFilter.Builder>	serializableBuilderClass()
LineItemFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<LineItemFilterValue>	values()	The values of the line item filter.
List<String>	valuesAsStrings()	The values of the line item filter.

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

attribute

public final LineItemFilterAttributeName attribute()

The attribute of the line item filter. This specifies what attribute that you can filter on.

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

Returns:

The attribute of the line item filter. This specifies what attribute that you can filter on.

See Also:

LineItemFilterAttributeName

attributeAsString

public final String attributeAsString()

The attribute of the line item filter. This specifies what attribute that you can filter on.

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

Returns:

The attribute of the line item filter. This specifies what attribute that you can filter on.

See Also:

LineItemFilterAttributeName

matchOption

public final MatchOption matchOption()

The match criteria of the line item filter. This parameter specifies whether not to include the resource value from the billing group total cost.

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

Returns:

The match criteria of the line item filter. This parameter specifies whether not to include the resource value from the billing group total cost.

See Also:

MatchOption

matchOptionAsString

public final String matchOptionAsString()

The match criteria of the line item filter. This parameter specifies whether not to include the resource value from the billing group total cost.

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

Returns:

The match criteria of the line item filter. This parameter specifies whether not to include the resource value from the billing group total cost.

See Also:

MatchOption

values

public final List<LineItemFilterValue> values()

The values of the line item filter. This specifies the values to filter on. Currently, you can only exclude Savings Plan discounts.

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 hasValues() method.

Returns:

The values of the line item filter. This specifies the values to filter on. Currently, you can only exclude Savings Plan discounts.

hasValues

public final boolean hasValues()

For responses, this returns true if the service returned a value for the Values 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.

valuesAsStrings

public final List<String> valuesAsStrings()

The values of the line item filter. This specifies the values to filter on. Currently, you can only exclude Savings Plan discounts.

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 hasValues() method.

Returns:

The values of the line item filter. This specifies the values to filter on. Currently, you can only exclude Savings Plan discounts.

toBuilder

public LineItemFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<LineItemFilter.Builder,LineItemFilter>

builder

public static LineItemFilter.Builder builder()

serializableBuilderClass

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