Package 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("software.amazon.awssdk:codegen") public final class ThingGroupIndexingConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ThingGroupIndexingConfiguration.Builder,ThingGroupIndexingConfiguration>

Thing group indexing configuration.

See Also:

  • Method Details

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

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

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ThingGroupIndexingConfiguration.Builder,ThingGroupIndexingConfiguration>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.