java.lang.Object
- software.amazon.awssdk.services.iot.model.ThingGroupIndexingConfiguration

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ThingGroupIndexingConfiguration.Builder,ThingGroupIndexingConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class ThingGroupIndexingConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ThingGroupIndexingConfiguration.Builder,ThingGroupIndexingConfiguration>

Thing group indexing configuration.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ThingGroupIndexingConfiguration.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ThingGroupIndexingConfiguration.Builder`	`builder()`
`List<Field>`	`customFields()`	A list of thing group fields to index.
`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.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ThingGroupIndexingConfiguration.Builder>`	`serializableBuilderClass()`
`ThingGroupIndexingMode`	`thingGroupIndexingMode()`	Thing group indexing mode.
`String`	`thingGroupIndexingModeAsString()`	Thing group indexing mode.
`ThingGroupIndexingConfiguration.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
  - thingGroupIndexingMode
```
public final ThingGroupIndexingMode thingGroupIndexingMode()
```
    Thing group indexing mode.
    
    If the service returns an enum value that is not available in the current SDK version, thingGroupIndexingMode will return ThingGroupIndexingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from thingGroupIndexingModeAsString().
    
    Returns:
    
    Thing group indexing mode.
    
    See Also:
    
    ThingGroupIndexingMode
  - thingGroupIndexingModeAsString
```
public final String thingGroupIndexingModeAsString()
```
    Thing group indexing mode.
    
    If the service returns an enum value that is not available in the current SDK version, thingGroupIndexingMode will return ThingGroupIndexingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from thingGroupIndexingModeAsString().
    
    Returns:
    
    Thing group indexing mode.
    
    See Also:
    
    ThingGroupIndexingMode
  - 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. This is an optional field. For more information, see Managed fields in the Amazon Web Services IoT Core Developer Guide.
    
    You can't modify managed fields by updating fleet indexing configuration.
    
    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. This is an optional field. For more information, see Managed fields in the Amazon Web Services IoT Core Developer Guide.
    
    You can't modify managed fields by updating fleet indexing configuration.
  - 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()
```
    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.
    
    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:
    
    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.
  - toBuilder
```
public ThingGroupIndexingConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ThingGroupIndexingConfiguration.Builder,ThingGroupIndexingConfiguration>
  - builder
```
public static ThingGroupIndexingConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ThingGroupIndexingConfiguration.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

Class ThingGroupIndexingConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

thingGroupIndexingMode

thingGroupIndexingModeAsString

hasManagedFields

managedFields

hasCustomFields

customFields

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields