ThingIndexingConfiguration (AWS Java SDK :: Services

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ThingIndexingConfiguration.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ThingIndexingConfiguration.Builder`	`builder()`
`List<Field>`	`customFields()` Contains custom field names and their data type.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCustomFields()` Returns true if the CustomFields property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasManagedFields()` Returns true if the ManagedFields property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<Field>`	`managedFields()` Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
`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 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 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 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 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
  - hasManagedFields
```
public boolean hasManagedFields()
```
    Returns true if the ManagedFields property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - managedFields
```
public 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.
    
    You can use hasManagedFields() to see if a value was sent in this field.
    
    Returns:
    
    Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
  - hasCustomFields
```
public boolean hasCustomFields()
```
    Returns true if the CustomFields property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - customFields
```
public 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.
    
    You can use hasCustomFields() to see if a value was sent in this field.
    
    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 int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ThingIndexingConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

thingIndexingMode

thingIndexingModeAsString

thingConnectivityIndexingMode

thingConnectivityIndexingModeAsString

hasManagedFields

managedFields

hasCustomFields

customFields

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields