software.amazon.awssdk.services.iot.model

Class ThingGroupIndexingConfiguration

java.lang.Object

software.amazon.awssdk.services.iot.model.ThingGroupIndexingConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ThingGroupIndexingConfiguration.Builder,ThingGroupIndexingConfiguration>

@Generated(value="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 and Description
static interface	ThingGroupIndexingConfiguration.Builder

Method Summary

Modifier and Type	Method and 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() 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 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 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 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 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()

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.

You can use hasCustomFields() to see if a value was sent in this field.

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 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