Package software.amazon.awssdk.services.qconnect.model

Class Filter

java.lang.Object

software.amazon.awssdk.services.qconnect.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>

A search filter.

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()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FilterField	field()	The field on which to filter.
String	fieldAsString()	The field on which to filter.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
FilterOperator	operator()	The operator to use for comparing the field’s value with the provided value.
String	operatorAsString()	The operator to use for comparing the field’s value with the provided value.
List<SdkField<?>>	sdkFields()
static Class<? extends Filter.Builder>	serializableBuilderClass()
Filter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	value()	The desired field value on which to 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

field

public final FilterField field()

The field on which to filter.

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

Returns:

The field on which to filter.

See Also:

FilterField

fieldAsString

public final String fieldAsString()

The field on which to filter.

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

Returns:

The field on which to filter.

See Also:

FilterField

operator

public final FilterOperator operator()

The operator to use for comparing the field’s value with the provided value.

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

Returns:

The operator to use for comparing the field’s value with the provided value.

See Also:

FilterOperator

operatorAsString

public final String operatorAsString()

The operator to use for comparing the field’s value with the provided value.

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

Returns:

The operator to use for comparing the field’s value with the provided value.

See Also:

FilterOperator

value

public final String value()

The desired field value on which to filter.

Returns:

The desired field value on which to filter.

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