software.amazon.awssdk.services.amplifyuibuilder.model

Class Predicate

java.lang.Object

software.amazon.awssdk.services.amplifyuibuilder.model.Predicate

All Implemented Interfaces:

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

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

Stores information for generating Amplify DataStore queries. Use a Predicate to retrieve a subset of the data in a collection.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Predicate.Builder

Method Summary

Modifier and Type	Method and Description
List<Predicate>	and() A list of predicates to combine logically.
static Predicate.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	field() The field to query.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAnd() For responses, this returns true if the service returned a value for the And property.
int	hashCode()
boolean	hasOr() For responses, this returns true if the service returned a value for the Or property.
String	operand() The value to use when performing the evaluation.
String	operator() The operator to use to perform the evaluation.
List<Predicate>	or() A list of predicates to combine logically.
List<SdkField<?>>	sdkFields()
static Class<? extends Predicate.Builder>	serializableBuilderClass()
Predicate.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

hasAnd

public final boolean hasAnd()

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

and

public final List<Predicate> and()

A list of predicates to combine logically.

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

Returns:

A list of predicates to combine logically.

field

public final String field()

The field to query.

Returns:

The field to query.

operand

public final String operand()

The value to use when performing the evaluation.

Returns:

The value to use when performing the evaluation.

operator

public final String operator()

The operator to use to perform the evaluation.

Returns:

The operator to use to perform the evaluation.

hasOr

public final boolean hasOr()

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

or

public final List<Predicate> or()

A list of predicates to combine logically.

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

Returns:

A list of predicates to combine logically.

toBuilder

public Predicate.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Predicate.Builder,Predicate>

builder

public static Predicate.Builder builder()

serializableBuilderClass

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