Package software.amazon.awssdk.services.forecast.model

Class Filter

java.lang.Object

software.amazon.awssdk.services.forecast.model.Filter

All Implemented Interfaces:

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

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

Describes a filter for choosing a subset of objects. Each filter consists of a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the objects that match the statement, respectively. The match statement consists of a key and a value.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Filter.Builder

Method Summary

Modifier and Type	Method	Description
static Filter.Builder	builder()
FilterConditionString	condition()	The condition to apply.
String	conditionAsString()	The condition to apply.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key()	The name of the parameter to filter on.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Filter.Builder>	serializableBuilderClass()
Filter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	value()	The value to match.

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

key

public final String key()

The name of the parameter to filter on.

Returns:

The name of the parameter to filter on.

value

public final String value()

The value to match.

Returns:

The value to match.

condition

public final FilterConditionString condition()

The condition to apply. To include the objects that match the statement, specify IS. To exclude matching objects, specify IS_NOT.

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

Returns:

The condition to apply. To include the objects that match the statement, specify IS. To exclude matching objects, specify IS_NOT.

See Also:

FilterConditionString

conditionAsString

public final String conditionAsString()

The condition to apply. To include the objects that match the statement, specify IS. To exclude matching objects, specify IS_NOT.

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

Returns:

The condition to apply. To include the objects that match the statement, specify IS. To exclude matching objects, specify IS_NOT.

See Also:

FilterConditionString

toBuilder

public Filter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Filter.Builder,Filter>

builder

public static Filter.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo