software.amazon.awssdk.services.connectcases.model

Class CaseFilter

java.lang.Object

software.amazon.awssdk.services.connectcases.model.CaseFilter

All Implemented Interfaces:

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

@Generated(value="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 and Description
static interface	CaseFilter.Builder
static class	CaseFilter.Type

Method Summary

Modifier and Type	Method and Description
List<CaseFilter>	andAll() Provides "and all" filtering.
static CaseFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FieldFilter	field() A list of fields to filter on.
static CaseFilter	fromAndAll(List<CaseFilter> andAll) Create an instance of this class with andAll() initialized to the given value.
static CaseFilter	fromField(Consumer<FieldFilter.Builder> field) Create an instance of this class with field() initialized to the given value.
static CaseFilter	fromField(FieldFilter field) Create an instance of this class with field() initialized to the given value.
static CaseFilter	fromNot(CaseFilter not) Create an instance of this class with not() initialized to the given value.
static CaseFilter	fromNot(Consumer<CaseFilter.Builder> not) Create an instance of this class with not() initialized to the given value.
static CaseFilter	fromOrAll(List<CaseFilter> orAll) Create an instance of this class with orAll() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAndAll() For responses, this returns true if the service returned a value for the AndAll property.
int	hashCode()
boolean	hasOrAll() For responses, this returns true if the service returned a value for the OrAll property.
CaseFilter	not() 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.Builder	toBuilder()
String	toString() Returns a string representation of this object.
CaseFilter.Type	type() 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 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.

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 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.

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:

toBuilder in interface ToCopyableBuilder<CaseFilter.Builder,CaseFilter>

builder

public static CaseFilter.Builder builder()

serializableBuilderClass

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

fromAndAll

public static CaseFilter fromAndAll(List<CaseFilter> andAll)

Create an instance of this class with andAll() 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 with field() 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 with field() 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 with not() 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 with not() 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 with orAll() 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 be CaseFilter.Type.UNKNOWN_TO_SDK_VERSION if 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 be CaseFilter.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo