Package software.amazon.awssdk.services.iotthingsgraph.model

Class EntityFilter

java.lang.Object

software.amazon.awssdk.services.iotthingsgraph.model.EntityFilter

All Implemented Interfaces:

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

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

An object that filters an entity search. Multiple filters function as OR criteria in the search. For example a search that includes a NAMESPACE and a REFERENCED_ENTITY_ID filter searches for entities in the specified namespace that use the entity specified by the value of REFERENCED_ENTITY_ID.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EntityFilter.Builder

Method Summary

Modifier and Type	Method	Description
static EntityFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValue()	For responses, this returns true if the service returned a value for the Value property.
EntityFilterName	name()	The name of the entity search filter field.
String	nameAsString()	The name of the entity search filter field.
List<SdkField<?>>	sdkFields()
static Class<? extends EntityFilter.Builder>	serializableBuilderClass()
EntityFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	value()	An array of string values for the search filter field.

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

name

public final EntityFilterName name()

The name of the entity search filter field. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

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

Returns:

The name of the entity search filter field. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

See Also:

EntityFilterName

nameAsString

public final String nameAsString()

The name of the entity search filter field. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

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

Returns:

The name of the entity search filter field. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

See Also:

EntityFilterName

hasValue

public final boolean hasValue()

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

value

public final List<String> value()

An array of string values for the search filter field. Multiple values function as AND criteria in the search.

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

Returns:

An array of string values for the search filter field. Multiple values function as AND criteria in the search.

toBuilder

public EntityFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EntityFilter.Builder,EntityFilter>

builder

public static EntityFilter.Builder builder()

serializableBuilderClass

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