software.amazon.awssdk.services.iottwinmaker.model

Class ListEntitiesFilter

java.lang.Object

software.amazon.awssdk.services.iottwinmaker.model.ListEntitiesFilter

All Implemented Interfaces:

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

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

An object that filters items in a list of entities.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListEntitiesFilter.Builder
static class	ListEntitiesFilter.Type

Method Summary

Modifier and Type	Method and Description
static ListEntitiesFilter.Builder	builder()
String	componentTypeId() The ID of the component type in the entities in the list.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	externalId() The external-Id property of a component.
static ListEntitiesFilter	fromComponentTypeId(String componentTypeId) Create an instance of this class with componentTypeId() initialized to the given value.
static ListEntitiesFilter	fromExternalId(String externalId) Create an instance of this class with externalId() initialized to the given value.
static ListEntitiesFilter	fromParentEntityId(String parentEntityId) Create an instance of this class with parentEntityId() initialized to the given value.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	parentEntityId() The parent of the entities in the list.
List<SdkField<?>>	sdkFields()
static Class<? extends ListEntitiesFilter.Builder>	serializableBuilderClass()
ListEntitiesFilter.Builder	toBuilder()
String	toString() Returns a string representation of this object.
ListEntitiesFilter.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

parentEntityId

public final String parentEntityId()

The parent of the entities in the list.

Returns:

The parent of the entities in the list.

componentTypeId

public final String componentTypeId()

The ID of the component type in the entities in the list.

Returns:

The ID of the component type in the entities in the list.

externalId

public final String externalId()

The external-Id property of a component. The external-Id property is the primary key of an external storage system.

Returns:

The external-Id property of a component. The external-Id property is the primary key of an external storage system.

toBuilder

public ListEntitiesFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListEntitiesFilter.Builder,ListEntitiesFilter>

builder

public static ListEntitiesFilter.Builder builder()

serializableBuilderClass

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

fromParentEntityId

public static ListEntitiesFilter fromParentEntityId(String parentEntityId)

Create an instance of this class with parentEntityId() initialized to the given value.

The parent of the entities in the list.

Parameters:

parentEntityId - The parent of the entities in the list.

fromComponentTypeId

public static ListEntitiesFilter fromComponentTypeId(String componentTypeId)

Create an instance of this class with componentTypeId() initialized to the given value.

The ID of the component type in the entities in the list.

Parameters:

componentTypeId - The ID of the component type in the entities in the list.

fromExternalId

public static ListEntitiesFilter fromExternalId(String externalId)

Create an instance of this class with externalId() initialized to the given value.

The external-Id property of a component. The external-Id property is the primary key of an external storage system.

Parameters:

externalId - The external-Id property of a component. The external-Id property is the primary key of an external storage system.

type

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