Class ThingIndexingConfiguration

java.lang.Object
software.amazon.awssdk.services.iot.model.ThingIndexingConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ThingIndexingConfiguration.Builder,ThingIndexingConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class ThingIndexingConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ThingIndexingConfiguration.Builder,ThingIndexingConfiguration>

The thing indexing configuration. For more information, see Managing Thing Indexing.

See Also:

  • Method Details

    • thingIndexingMode

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, thingIndexingMode will return ThingIndexingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from thingIndexingModeAsString().

      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:

    • thingIndexingModeAsString

      public final String thingIndexingModeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, thingIndexingMode will return ThingIndexingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from thingIndexingModeAsString().

      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:

    • thingConnectivityIndexingMode

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, thingConnectivityIndexingMode will return ThingConnectivityIndexingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from thingConnectivityIndexingModeAsString().

      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:

    • thingConnectivityIndexingModeAsString

      public final String thingConnectivityIndexingModeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, thingConnectivityIndexingMode will return ThingConnectivityIndexingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from thingConnectivityIndexingModeAsString().

      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:

    • deviceDefenderIndexingMode

      public final DeviceDefenderIndexingMode deviceDefenderIndexingMode()

      Device Defender indexing mode. Valid values are:

      • VIOLATIONS – Your thing index contains Device Defender violations. To enable Device Defender indexing, deviceDefenderIndexingMode must not be set to OFF.

      • OFF - Device Defender indexing is disabled.

      For more information about Device Defender violations, see Device Defender Detect.

      If the service returns an enum value that is not available in the current SDK version, deviceDefenderIndexingMode will return DeviceDefenderIndexingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deviceDefenderIndexingModeAsString().

      Returns:
      Device Defender indexing mode. Valid values are:

      • VIOLATIONS – Your thing index contains Device Defender violations. To enable Device Defender indexing, deviceDefenderIndexingMode must not be set to OFF.

      • OFF - Device Defender indexing is disabled.

      For more information about Device Defender violations, see Device Defender Detect.

      See Also:

    • deviceDefenderIndexingModeAsString

      public final String deviceDefenderIndexingModeAsString()

      Device Defender indexing mode. Valid values are:

      • VIOLATIONS – Your thing index contains Device Defender violations. To enable Device Defender indexing, deviceDefenderIndexingMode must not be set to OFF.

      • OFF - Device Defender indexing is disabled.

      For more information about Device Defender violations, see Device Defender Detect.

      If the service returns an enum value that is not available in the current SDK version, deviceDefenderIndexingMode will return DeviceDefenderIndexingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deviceDefenderIndexingModeAsString().

      Returns:
      Device Defender indexing mode. Valid values are:

      • VIOLATIONS – Your thing index contains Device Defender violations. To enable Device Defender indexing, deviceDefenderIndexingMode must not be set to OFF.

      • OFF - Device Defender indexing is disabled.

      For more information about Device Defender violations, see Device Defender Detect.

      See Also:

    • namedShadowIndexingMode

      public final NamedShadowIndexingMode namedShadowIndexingMode()

      Named shadow indexing mode. Valid values are:

      • ON – Your thing index contains named shadow. To enable thing named shadow indexing, namedShadowIndexingMode must not be set to OFF.

      • OFF - Named shadow indexing is disabled.

      For more information about Shadows, see IoT Device Shadow service.

      If the service returns an enum value that is not available in the current SDK version, namedShadowIndexingMode will return NamedShadowIndexingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from namedShadowIndexingModeAsString().

      Returns:
      Named shadow indexing mode. Valid values are:

      • ON – Your thing index contains named shadow. To enable thing named shadow indexing, namedShadowIndexingMode must not be set to OFF.

      • OFF - Named shadow indexing is disabled.

      For more information about Shadows, see IoT Device Shadow service.

      See Also:

    • namedShadowIndexingModeAsString

      public final String namedShadowIndexingModeAsString()

      Named shadow indexing mode. Valid values are:

      • ON – Your thing index contains named shadow. To enable thing named shadow indexing, namedShadowIndexingMode must not be set to OFF.

      • OFF - Named shadow indexing is disabled.

      For more information about Shadows, see IoT Device Shadow service.

      If the service returns an enum value that is not available in the current SDK version, namedShadowIndexingMode will return NamedShadowIndexingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from namedShadowIndexingModeAsString().

      Returns:
      Named shadow indexing mode. Valid values are:

      • ON – Your thing index contains named shadow. To enable thing named shadow indexing, namedShadowIndexingMode must not be set to OFF.

      • OFF - Named shadow indexing is disabled.

      For more information about Shadows, see IoT Device Shadow service.

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

      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:
      Contains custom field names and their data type.

    • filter

      public final IndexingFilter filter()

      Provides additional selections for named shadows and geolocation data.

      To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and specify your shadow names in namedShadowNames filter.

      To add geolocation data to your fleet indexing configuration:

      • If you store geolocation data in a class/unnamed shadow, set thingIndexingMode to be REGISTRY_AND_SHADOW and specify your geolocation data in geoLocations filter.

      • If you store geolocation data in a named shadow, set namedShadowIndexingMode to be ON, add the shadow name in namedShadowNames filter, and specify your geolocation data in geoLocations filter. For more information, see Managing fleet indexing.

      Returns:
      Provides additional selections for named shadows and geolocation data.

      To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and specify your shadow names in namedShadowNames filter.

      To add geolocation data to your fleet indexing configuration:

      • If you store geolocation data in a class/unnamed shadow, set thingIndexingMode to be REGISTRY_AND_SHADOW and specify your geolocation data in geoLocations filter.

      • If you store geolocation data in a named shadow, set namedShadowIndexingMode to be ON, add the shadow name in namedShadowNames filter, and specify your geolocation data in geoLocations filter. For more information, see Managing fleet indexing.

    • toBuilder

      public ThingIndexingConfiguration.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<ThingIndexingConfiguration.Builder,ThingIndexingConfiguration>
      Returns:
      a builder for type T

    • builder

      public static ThingIndexingConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ThingIndexingConfiguration.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.