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()
List<Field>	customFields() Contains custom field names and their data type.
DeviceDefenderIndexingMode	deviceDefenderIndexingMode() Device Defender indexing mode.
String	deviceDefenderIndexingModeAsString() Device Defender indexing mode.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCustomFields() For responses, this returns true if the service returned a value for the CustomFields property.
int	hashCode()
boolean	hasManagedFields() For responses, this returns true if the service returned a value for the ManagedFields property.
List<Field>	managedFields() Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
NamedShadowIndexingMode	namedShadowIndexingMode() Named shadow indexing mode.
String	namedShadowIndexingModeAsString() Named shadow indexing mode.
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()
String	toString() Returns a string representation of this object.

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

thingIndexingMode

public final ThingIndexingMode thingIndexingMode()

Thing indexing mode. Valid values are:

• REGISTRY – Your thing index contains registry data only.

• REGISTRY_AND_SHADOW - Your thing index contains 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 contains registry data only.

• REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.

• OFF - Thing indexing is disabled.

See Also:

ThingIndexingMode

thingIndexingModeAsString

public final String thingIndexingModeAsString()

Thing indexing mode. Valid values are:

• REGISTRY – Your thing index contains registry data only.

• REGISTRY_AND_SHADOW - Your thing index contains 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 contains registry data only.

• REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.

• OFF - Thing indexing is disabled.

See Also:

ThingIndexingMode

thingConnectivityIndexingMode

public final ThingConnectivityIndexingMode thingConnectivityIndexingMode()

Thing connectivity indexing mode. Valid values are:

• STATUS – Your thing index contains connectivity status. 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 contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF.

• OFF - Thing connectivity status indexing is disabled.

See Also:

ThingConnectivityIndexingMode

thingConnectivityIndexingModeAsString

public final String thingConnectivityIndexingModeAsString()

Thing connectivity indexing mode. Valid values are:

• STATUS – Your thing index contains connectivity status. 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 contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF.

• OFF - Thing connectivity status indexing is disabled.

See Also:

ThingConnectivityIndexingMode

deviceDefenderIndexingMode

public final DeviceDefenderIndexingMode deviceDefenderIndexingMode()

Device Defender indexing mode. Valid values are:

• VIOLATIONS – Your thing index contains Device Defender violations. To enable Device Defender indexing, deviceDefenderIndexingMode must not be set to OFF.

• OFF - Device Defender indexing is disabled.

For more information about Device Defender violations, see Device Defender Detect.

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

Returns:

Device Defender indexing mode. Valid values are:

• VIOLATIONS – Your thing index contains Device Defender violations. To enable Device Defender indexing, deviceDefenderIndexingMode must not be set to OFF.

• OFF - Device Defender indexing is disabled.

For more information about Device Defender violations, see Device Defender Detect.

See Also:

DeviceDefenderIndexingMode

deviceDefenderIndexingModeAsString

public final String deviceDefenderIndexingModeAsString()

Device Defender indexing mode. Valid values are:

• VIOLATIONS – Your thing index contains Device Defender violations. To enable Device Defender indexing, deviceDefenderIndexingMode must not be set to OFF.

• OFF - Device Defender indexing is disabled.

For more information about Device Defender violations, see Device Defender Detect.

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

Returns:

Device Defender indexing mode. Valid values are:

• VIOLATIONS – Your thing index contains Device Defender violations. To enable Device Defender indexing, deviceDefenderIndexingMode must not be set to OFF.

• OFF - Device Defender indexing is disabled.

For more information about Device Defender violations, see Device Defender Detect.

See Also:

DeviceDefenderIndexingMode

namedShadowIndexingMode

public final NamedShadowIndexingMode namedShadowIndexingMode()

Named shadow indexing mode. Valid values are:

• ON – Your thing index contains named shadow. To enable thing named shadow indexing, namedShadowIndexingMode must not be set to OFF.

• OFF - Named shadow indexing is disabled.

For more information about Shadows, see IoT Device Shadow service.

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

Returns:

Named shadow indexing mode. Valid values are:

• ON – Your thing index contains named shadow. To enable thing named shadow indexing, namedShadowIndexingMode must not be set to OFF.

• OFF - Named shadow indexing is disabled.

For more information about Shadows, see IoT Device Shadow service.

See Also:

NamedShadowIndexingMode

namedShadowIndexingModeAsString

public final String namedShadowIndexingModeAsString()

Named shadow indexing mode. Valid values are:

• ON – Your thing index contains named shadow. To enable thing named shadow indexing, namedShadowIndexingMode must not be set to OFF.

• OFF - Named shadow indexing is disabled.

For more information about Shadows, see IoT Device Shadow service.

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

Returns:

Named shadow indexing mode. Valid values are:

• ON – Your thing index contains named shadow. To enable thing named shadow indexing, namedShadowIndexingMode must not be set to OFF.

• OFF - Named shadow indexing is disabled.

For more information about Shadows, see IoT Device Shadow service.

See Also:

NamedShadowIndexingMode

hasManagedFields

public final boolean hasManagedFields()

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

managedFields

public final List<Field> managedFields()

Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

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

Returns:

Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

hasCustomFields

public final boolean hasCustomFields()

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

customFields

public final List<Field> customFields()

Contains custom field names and their data type.

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

Returns:

Contains custom field names and their data type.

toBuilder

public ThingIndexingConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ThingIndexingConfiguration.Builder,ThingIndexingConfiguration>

builder

public static ThingIndexingConfiguration.Builder builder()

serializableBuilderClass

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