ThingGroupIndexingConfiguration (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Thing group indexing configuration.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

ThingGroupIndexingConfiguration()

Constructors
Constructor and Description
`ThingGroupIndexingConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ThingGroupIndexingConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`List<Field>`	`getCustomFields()` A list of thing group fields to index.
`List<Field>`	`getManagedFields()` Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
`String`	`getThingGroupIndexingMode()` Thing group indexing mode.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCustomFields(Collection<Field> customFields)` A list of thing group fields to index.
`void`	`setManagedFields(Collection<Field> managedFields)` Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
`void`	`setThingGroupIndexingMode(String thingGroupIndexingMode)` Thing group indexing mode.
`String`	`toString()` Returns a string representation of this object.
`ThingGroupIndexingConfiguration`	`withCustomFields(Collection<Field> customFields)` A list of thing group fields to index.
`ThingGroupIndexingConfiguration`	`withCustomFields(Field... customFields)` A list of thing group fields to index.
`ThingGroupIndexingConfiguration`	`withManagedFields(Collection<Field> managedFields)` Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
`ThingGroupIndexingConfiguration`	`withManagedFields(Field... managedFields)` Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
`ThingGroupIndexingConfiguration`	`withThingGroupIndexingMode(String thingGroupIndexingMode)` Thing group indexing mode.
`ThingGroupIndexingConfiguration`	`withThingGroupIndexingMode(ThingGroupIndexingMode thingGroupIndexingMode)` Thing group indexing mode.

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

- Constructor Detail
  - ThingGroupIndexingConfiguration
```
public ThingGroupIndexingConfiguration()
```
- Method Detail
  - setThingGroupIndexingMode
```
public void setThingGroupIndexingMode(String thingGroupIndexingMode)
```
    Thing group indexing mode.
    
    Parameters:
    
    thingGroupIndexingMode - Thing group indexing mode.
    
    See Also:
    
    ThingGroupIndexingMode
  - getThingGroupIndexingMode
```
public String getThingGroupIndexingMode()
```
    Thing group indexing mode.
    
    Returns:
    
    Thing group indexing mode.
    
    See Also:
    
    ThingGroupIndexingMode
  - withThingGroupIndexingMode
```
public ThingGroupIndexingConfiguration withThingGroupIndexingMode(String thingGroupIndexingMode)
```
    Thing group indexing mode.
    
    Parameters:
    
    thingGroupIndexingMode - Thing group indexing mode.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ThingGroupIndexingMode
  - withThingGroupIndexingMode
```
public ThingGroupIndexingConfiguration withThingGroupIndexingMode(ThingGroupIndexingMode thingGroupIndexingMode)
```
    Thing group indexing mode.
    
    Parameters:
    
    thingGroupIndexingMode - Thing group indexing mode.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ThingGroupIndexingMode
  - 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 ThingGroupIndexingConfiguration 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 ThingGroupIndexingConfiguration 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()
```
    A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.
    
    Contains custom field names and their data type.
    
    Returns:
    
    A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.
    
    Contains custom field names and their data type.
  - setCustomFields
```
public void setCustomFields(Collection<Field> customFields)
```
    A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.
    
    Contains custom field names and their data type.
    
    Parameters:
    
    customFields - A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.
    
    Contains custom field names and their data type.
  - withCustomFields
```
public ThingGroupIndexingConfiguration withCustomFields(Field... customFields)
```
    A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.
    
    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 - A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.
    
    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 ThingGroupIndexingConfiguration withCustomFields(Collection<Field> customFields)
```
    A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.
    
    Contains custom field names and their data type.
    
    Parameters:
    
    customFields - A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.
    
    Contains custom field names and their data type.
    
    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 ThingGroupIndexingConfiguration 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 ThingGroupIndexingConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ThingGroupIndexingConfiguration

Method Detail

setThingGroupIndexingMode

getThingGroupIndexingMode

withThingGroupIndexingMode

withThingGroupIndexingMode

getManagedFields

setManagedFields

withManagedFields

withManagedFields

getCustomFields

setCustomFields

withCustomFields

withCustomFields

toString

equals

hashCode

clone

marshall