ThingIndexingConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iot.model.ThingIndexingConfiguration

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ThingIndexingConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

ThingIndexingConfiguration()

Constructors
Constructor and Description
`ThingIndexingConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ThingIndexingConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`List<Field>`	`getCustomFields()` Contains custom field names and their data type.
`String`	`getDeviceDefenderIndexingMode()` Device Defender indexing mode.
`IndexingFilter`	`getFilter()` Provides additional filters for specific data sources.
`List<Field>`	`getManagedFields()` Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
`String`	`getNamedShadowIndexingMode()` Named shadow indexing mode.
`String`	`getThingConnectivityIndexingMode()` Thing connectivity indexing mode.
`String`	`getThingIndexingMode()` Thing indexing mode.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCustomFields(Collection<Field> customFields)` Contains custom field names and their data type.
`void`	`setDeviceDefenderIndexingMode(String deviceDefenderIndexingMode)` Device Defender indexing mode.
`void`	`setFilter(IndexingFilter filter)` Provides additional filters for specific data sources.
`void`	`setManagedFields(Collection<Field> managedFields)` Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
`void`	`setNamedShadowIndexingMode(String namedShadowIndexingMode)` Named shadow indexing mode.
`void`	`setThingConnectivityIndexingMode(String thingConnectivityIndexingMode)` Thing connectivity indexing mode.
`void`	`setThingIndexingMode(String thingIndexingMode)` Thing indexing mode.
`String`	`toString()` Returns a string representation of this object.
`ThingIndexingConfiguration`	`withCustomFields(Collection<Field> customFields)` Contains custom field names and their data type.
`ThingIndexingConfiguration`	`withCustomFields(Field... customFields)` Contains custom field names and their data type.
`ThingIndexingConfiguration`	`withDeviceDefenderIndexingMode(DeviceDefenderIndexingMode deviceDefenderIndexingMode)` Device Defender indexing mode.
`ThingIndexingConfiguration`	`withDeviceDefenderIndexingMode(String deviceDefenderIndexingMode)` Device Defender indexing mode.
`ThingIndexingConfiguration`	`withFilter(IndexingFilter filter)` Provides additional filters for specific data sources.
`ThingIndexingConfiguration`	`withManagedFields(Collection<Field> managedFields)` Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
`ThingIndexingConfiguration`	`withManagedFields(Field... managedFields)` Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
`ThingIndexingConfiguration`	`withNamedShadowIndexingMode(NamedShadowIndexingMode namedShadowIndexingMode)` Named shadow indexing mode.
`ThingIndexingConfiguration`	`withNamedShadowIndexingMode(String namedShadowIndexingMode)` Named shadow indexing mode.
`ThingIndexingConfiguration`	`withThingConnectivityIndexingMode(String thingConnectivityIndexingMode)` Thing connectivity indexing mode.
`ThingIndexingConfiguration`	`withThingConnectivityIndexingMode(ThingConnectivityIndexingMode thingConnectivityIndexingMode)` Thing connectivity indexing mode.
`ThingIndexingConfiguration`	`withThingIndexingMode(String thingIndexingMode)` Thing indexing mode.
`ThingIndexingConfiguration`	`withThingIndexingMode(ThingIndexingMode thingIndexingMode)` Thing indexing mode.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ThingIndexingConfiguration
```
public ThingIndexingConfiguration()
```
- Method Detail
  - setThingIndexingMode
```
public void setThingIndexingMode(String 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.
    Parameters:
    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.
    See Also:
    
    ThingIndexingMode
  - getThingIndexingMode
```
public String getThingIndexingMode()
```
    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.
    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
  - withThingIndexingMode
```
public ThingIndexingConfiguration withThingIndexingMode(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ThingIndexingMode
  - withThingIndexingMode
```
public ThingIndexingConfiguration withThingIndexingMode(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ThingIndexingMode
  - setThingConnectivityIndexingMode
```
public void setThingConnectivityIndexingMode(String 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.
    Parameters:
    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.
    See Also:
    
    ThingConnectivityIndexingMode
  - getThingConnectivityIndexingMode
```
public String getThingConnectivityIndexingMode()
```
    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.
    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
  - withThingConnectivityIndexingMode
```
public ThingIndexingConfiguration withThingConnectivityIndexingMode(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ThingConnectivityIndexingMode
  - withThingConnectivityIndexingMode
```
public ThingIndexingConfiguration withThingConnectivityIndexingMode(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ThingConnectivityIndexingMode
  - setDeviceDefenderIndexingMode
```
public void setDeviceDefenderIndexingMode(String 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.
    Parameters:
    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.
    See Also:
    
    DeviceDefenderIndexingMode
  - getDeviceDefenderIndexingMode
```
public String getDeviceDefenderIndexingMode()
```
    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.
    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
  - withDeviceDefenderIndexingMode
```
public ThingIndexingConfiguration withDeviceDefenderIndexingMode(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeviceDefenderIndexingMode
  - withDeviceDefenderIndexingMode
```
public ThingIndexingConfiguration withDeviceDefenderIndexingMode(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DeviceDefenderIndexingMode
  - setNamedShadowIndexingMode
```
public void setNamedShadowIndexingMode(String 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.
    Parameters:
    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.
    See Also:
    
    NamedShadowIndexingMode
  - getNamedShadowIndexingMode
```
public String getNamedShadowIndexingMode()
```
    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.
    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
  - withNamedShadowIndexingMode
```
public ThingIndexingConfiguration withNamedShadowIndexingMode(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NamedShadowIndexingMode
  - withNamedShadowIndexingMode
```
public ThingIndexingConfiguration withNamedShadowIndexingMode(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NamedShadowIndexingMode
  - getManagedFields
```
public List<Field> getManagedFields()
```
    Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
    
    Returns:
    
    Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
  - setManagedFields
```
public void setManagedFields(Collection<Field> managedFields)
```
    Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
    
    Parameters:
    
    managedFields - Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
  - withManagedFields
```
public ThingIndexingConfiguration withManagedFields(Field... managedFields)
```
    Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
    
    NOTE: This method appends the values to the existing list (if any). Use setManagedFields(java.util.Collection) or withManagedFields(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    managedFields - Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withManagedFields
```
public ThingIndexingConfiguration withManagedFields(Collection<Field> managedFields)
```
    Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
    
    Parameters:
    
    managedFields - Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCustomFields
```
public List<Field> getCustomFields()
```
    Contains custom field names and their data type.
    
    Returns:
    
    Contains custom field names and their data type.
  - setCustomFields
```
public void setCustomFields(Collection<Field> customFields)
```
    Contains custom field names and their data type.
    
    Parameters:
    
    customFields - Contains custom field names and their data type.
  - withCustomFields
```
public ThingIndexingConfiguration withCustomFields(Field... customFields)
```
    Contains custom field names and their data type.
    
    NOTE: This method appends the values to the existing list (if any). Use setCustomFields(java.util.Collection) or withCustomFields(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    customFields - Contains custom field names and their data type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCustomFields
```
public ThingIndexingConfiguration withCustomFields(Collection<Field> customFields)
```
    Contains custom field names and their data type.
    
    Parameters:
    
    customFields - Contains custom field names and their data type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFilter
```
public void setFilter(IndexingFilter filter)
```
    Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and specify your shadow names in filter.
    
    Parameters:
    
    filter - Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and specify your shadow names in filter.
  - getFilter
```
public IndexingFilter getFilter()
```
    Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and specify your shadow names in filter.
    
    Returns:
    
    Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and specify your shadow names in filter.
  - withFilter
```
public ThingIndexingConfiguration withFilter(IndexingFilter filter)
```
    Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and specify your shadow names in filter.
    
    Parameters:
    
    filter - Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and specify your shadow names in filter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ThingIndexingConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ThingIndexingConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ThingIndexingConfiguration

Method Detail

setThingIndexingMode

getThingIndexingMode

withThingIndexingMode

withThingIndexingMode

setThingConnectivityIndexingMode

getThingConnectivityIndexingMode

withThingConnectivityIndexingMode

withThingConnectivityIndexingMode

setDeviceDefenderIndexingMode

getDeviceDefenderIndexingMode

withDeviceDefenderIndexingMode

withDeviceDefenderIndexingMode

setNamedShadowIndexingMode

getNamedShadowIndexingMode

withNamedShadowIndexingMode

withNamedShadowIndexingMode

getManagedFields

setManagedFields

withManagedFields

withManagedFields

getCustomFields

setCustomFields

withCustomFields

withCustomFields

setFilter

getFilter

withFilter

toString

equals

hashCode

clone

marshall