ThingIndexingConfiguration (AWS Java SDK for AWS IoT 1.11.678 API)

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()` A list of thing fields to index.
`List<Field>`	`getManagedFields()` A list of automatically indexed thing fields.
`String`	`getThingConnectivityIndexingMode()` Thing connectivity indexing mode.
`String`	`getThingIndexingMode()` Thing indexing mode.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setCustomFields(Collection<Field> customFields)` A list of thing fields to index.
`void`	`setManagedFields(Collection<Field> managedFields)` A list of automatically indexed thing fields.
`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)` A list of thing fields to index.
`ThingIndexingConfiguration`	`withCustomFields(Field... customFields)` A list of thing fields to index.
`ThingIndexingConfiguration`	`withManagedFields(Collection<Field> managedFields)` A list of automatically indexed thing fields.
`ThingIndexingConfiguration`	`withManagedFields(Field... managedFields)` A list of automatically indexed thing fields.
`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
finalize, 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
  - getManagedFields
```
public List<Field> getManagedFields()
```
    A list of automatically indexed thing fields.
    
    Returns:
    
    A list of automatically indexed thing fields.
  - setManagedFields
```
public void setManagedFields(Collection<Field> managedFields)
```
    A list of automatically indexed thing fields.
    
    Parameters:
    
    managedFields - A list of automatically indexed thing fields.
  - withManagedFields
```
public ThingIndexingConfiguration withManagedFields(Field... managedFields)
```
    A list of automatically indexed thing fields.
    
    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 - A list of automatically indexed thing fields.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withManagedFields
```
public ThingIndexingConfiguration withManagedFields(Collection<Field> managedFields)
```
    A list of automatically indexed thing fields.
    
    Parameters:
    
    managedFields - A list of automatically indexed thing fields.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCustomFields
```
public List<Field> getCustomFields()
```
    A list of thing fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.
    
    Returns:
    
    A list of thing fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.
  - setCustomFields
```
public void setCustomFields(Collection<Field> customFields)
```
    A list of thing fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.
    
    Parameters:
    
    customFields - A list of thing fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.
  - withCustomFields
```
public ThingIndexingConfiguration withCustomFields(Field... customFields)
```
    A list of thing fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.
    
    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 - A list of thing fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCustomFields
```
public ThingIndexingConfiguration withCustomFields(Collection<Field> customFields)
```
    A list of thing fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.
    
    Parameters:
    
    customFields - A list of thing fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.
    
    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)
```
    Specified by:
    
    marshall in interface StructuredPojo

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

getManagedFields

setManagedFields

withManagedFields

withManagedFields

getCustomFields

setCustomFields

withCustomFields

withCustomFields

toString

equals

hashCode

clone

marshall