Class Predicate
- java.lang.Object
-
- software.amazon.awssdk.services.amplifyuibuilder.model.Predicate
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Predicate.Builder,Predicate>
@Generated("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
Predicateto retrieve a subset of the data in a collection.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfacePredicate.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<Predicate>and()A list of predicates to combine logically.static Predicate.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)Stringfield()The field to query.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAnd()For responses, this returns true if the service returned a value for the And property.inthashCode()booleanhasOr()For responses, this returns true if the service returned a value for the Or property.Stringoperand()The value to use when performing the evaluation.StringoperandType()The type of value to use when performing the evaluation.Stringoperator()The operator to use to perform the evaluation.List<Predicate>or()A list of predicates to combine logically.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends Predicate.Builder>serializableBuilderClass()Predicate.BuildertoBuilder()StringtoString()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
-
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 theisEmpty()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.
-
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 theisEmpty()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.
-
operator
public final String operator()
The operator to use to perform the evaluation.
- Returns:
- The operator to use to perform the evaluation.
-
operand
public final String operand()
The value to use when performing the evaluation.
- Returns:
- The value to use when performing the evaluation.
-
operandType
public final String operandType()
The type of value to use when performing the evaluation.
- Returns:
- The type of value to use when performing the evaluation.
-
toBuilder
public Predicate.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Predicate.Builder,Predicate>
-
builder
public static Predicate.Builder builder()
-
serializableBuilderClass
public static Class<? extends Predicate.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-