software.amazon.awssdk.services.iot.model

Class ThingIndexingConfiguration

java.lang.Object

software.amazon.awssdk.services.iot.model.ThingIndexingConfiguration

All Implemented Interfaces:

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

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

The thing indexing configuration. For more information, see Managing Thing Indexing.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ThingIndexingConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static ThingIndexingConfiguration.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ThingIndexingConfiguration.Builder>	serializableBuilderClass()
ThingConnectivityIndexingMode	thingConnectivityIndexingMode() Thing connectivity indexing mode.
String	thingConnectivityIndexingModeAsString() Thing connectivity indexing mode.
ThingIndexingMode	thingIndexingMode() Thing indexing mode.
String	thingIndexingModeAsString() Thing indexing mode.
ThingIndexingConfiguration.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

thingIndexingMode

public ThingIndexingMode thingIndexingMode()

Thing indexing mode. Valid values are:

• REGISTRY – Your thing index will contain only registry data.

• REGISTRY_AND_SHADOW - Your thing index will contain registry and shadow data.

• OFF - Thing indexing is disabled.

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

Returns:

Thing indexing mode. Valid values are:

• REGISTRY – Your thing index will contain only registry data.

• REGISTRY_AND_SHADOW - Your thing index will contain registry and shadow data.

• OFF - Thing indexing is disabled.

See Also:

ThingIndexingMode

thingIndexingModeAsString

public String thingIndexingModeAsString()

Thing indexing mode. Valid values are:

• REGISTRY – Your thing index will contain only registry data.

• REGISTRY_AND_SHADOW - Your thing index will contain registry and shadow data.

• OFF - Thing indexing is disabled.

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

Returns:

Thing indexing mode. Valid values are:

• REGISTRY – Your thing index will contain only registry data.

• REGISTRY_AND_SHADOW - Your thing index will contain registry and shadow data.

• OFF - Thing indexing is disabled.

See Also:

ThingIndexingMode

thingConnectivityIndexingMode

public ThingConnectivityIndexingMode thingConnectivityIndexingMode()

Thing connectivity indexing mode. Valid values are:

• STATUS – Your thing index will contain connectivity status. In order to enable thing connectivity indexing, thingIndexMode must not be set to OFF.

• OFF - Thing connectivity status indexing is disabled.

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

Returns:

Thing connectivity indexing mode. Valid values are:

• STATUS – Your thing index will contain connectivity status. In order to enable thing connectivity indexing, thingIndexMode must not be set to OFF.

• OFF - Thing connectivity status indexing is disabled.

See Also:

ThingConnectivityIndexingMode

thingConnectivityIndexingModeAsString

public String thingConnectivityIndexingModeAsString()

Thing connectivity indexing mode. Valid values are:

• STATUS – Your thing index will contain connectivity status. In order to enable thing connectivity indexing, thingIndexMode must not be set to OFF.

• OFF - Thing connectivity status indexing is disabled.

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

Returns:

Thing connectivity indexing mode. Valid values are:

• STATUS – Your thing index will contain connectivity status. In order to enable thing connectivity indexing, thingIndexMode must not be set to OFF.

• OFF - Thing connectivity status indexing is disabled.

See Also:

ThingConnectivityIndexingMode

toBuilder

public ThingIndexingConfiguration.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ThingIndexingConfiguration.Builder,ThingIndexingConfiguration>

Returns:

a builder for type T

builder

public static ThingIndexingConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends ThingIndexingConfiguration.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.