Class CaseFilter
- java.lang.Object
-
- software.amazon.awssdk.services.connectcases.model.CaseFilter
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<CaseFilter.Builder,CaseFilter>
@Generated("software.amazon.awssdk:codegen") public final class CaseFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CaseFilter.Builder,CaseFilter>
A filter for cases. Only one value can be provided.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCaseFilter.Builderstatic classCaseFilter.Type
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<CaseFilter>andAll()Provides "and all" filtering.static CaseFilter.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)FieldFilterfield()A list of fields to filter on.static CaseFilterfromAndAll(List<CaseFilter> andAll)Create an instance of this class withandAll()initialized to the given value.static CaseFilterfromField(Consumer<FieldFilter.Builder> field)Create an instance of this class withfield()initialized to the given value.static CaseFilterfromField(FieldFilter field)Create an instance of this class withfield()initialized to the given value.static CaseFilterfromNot(Consumer<CaseFilter.Builder> not)Create an instance of this class withnot()initialized to the given value.static CaseFilterfromNot(CaseFilter not)Create an instance of this class withnot()initialized to the given value.static CaseFilterfromOrAll(List<CaseFilter> orAll)Create an instance of this class withorAll()initialized to the given value.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAndAll()For responses, this returns true if the service returned a value for the AndAll property.inthashCode()booleanhasOrAll()For responses, this returns true if the service returned a value for the OrAll property.CaseFilternot()Returns the value of the Not property for this object.List<CaseFilter>orAll()Provides "or all" filtering.List<SdkField<?>>sdkFields()static Class<? extends CaseFilter.Builder>serializableBuilderClass()CaseFilter.BuildertoBuilder()StringtoString()Returns a string representation of this object.CaseFilter.Typetype()Retrieve an enum value representing which member of this object is populated.-
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
-
hasAndAll
public final boolean hasAndAll()
For responses, this returns true if the service returned a value for the AndAll 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.
-
andAll
public final List<CaseFilter> andAll()
Provides "and all" filtering.
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
hasAndAll()method.- Returns:
- Provides "and all" filtering.
-
field
public final FieldFilter field()
A list of fields to filter on.
- Returns:
- A list of fields to filter on.
-
not
public final CaseFilter not()
Returns the value of the Not property for this object.- Returns:
- The value of the Not property for this object.
-
hasOrAll
public final boolean hasOrAll()
For responses, this returns true if the service returned a value for the OrAll 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.
-
orAll
public final List<CaseFilter> orAll()
Provides "or all" filtering.
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
hasOrAll()method.- Returns:
- Provides "or all" filtering.
-
toBuilder
public CaseFilter.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CaseFilter.Builder,CaseFilter>
-
builder
public static CaseFilter.Builder builder()
-
serializableBuilderClass
public static Class<? extends CaseFilter.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.
-
fromAndAll
public static CaseFilter fromAndAll(List<CaseFilter> andAll)
Create an instance of this class withandAll()initialized to the given value.Provides "and all" filtering.
- Parameters:
andAll- Provides "and all" filtering.
-
fromField
public static CaseFilter fromField(FieldFilter field)
Create an instance of this class withfield()initialized to the given value.A list of fields to filter on.
- Parameters:
field- A list of fields to filter on.
-
fromField
public static CaseFilter fromField(Consumer<FieldFilter.Builder> field)
Create an instance of this class withfield()initialized to the given value.A list of fields to filter on.
- Parameters:
field- A list of fields to filter on.
-
fromNot
public static CaseFilter fromNot(CaseFilter not)
Create an instance of this class withnot()initialized to the given value. Sets the value of the Not property for this object.- Parameters:
not- The new value for the Not property for this object.
-
fromNot
public static CaseFilter fromNot(Consumer<CaseFilter.Builder> not)
Create an instance of this class withnot()initialized to the given value. Sets the value of the Not property for this object.- Parameters:
not- The new value for the Not property for this object.
-
fromOrAll
public static CaseFilter fromOrAll(List<CaseFilter> orAll)
Create an instance of this class withorAll()initialized to the given value.Provides "or all" filtering.
- Parameters:
orAll- Provides "or all" filtering.
-
type
public CaseFilter.Type type()
Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will beCaseFilter.Type.UNKNOWN_TO_SDK_VERSIONif the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will beCaseFilter.Type.UNKNOWN_TO_SDK_VERSIONif zero members are set, andnullif more than one member is set.
-
-