Package software.amazon.awssdk.services.iot.model

Interface ThingIndexingConfiguration.Builder

    • Method Detail

      • thingIndexingMode

        ThingIndexingConfiguration.Builder thingIndexingMode​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ThingIndexingMode, ThingIndexingMode

      • thingIndexingMode

        ThingIndexingConfiguration.Builder thingIndexingMode​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ThingIndexingMode, ThingIndexingMode

      • thingConnectivityIndexingMode

        ThingIndexingConfiguration.Builder thingConnectivityIndexingMode​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ThingConnectivityIndexingMode, ThingConnectivityIndexingMode

      • thingConnectivityIndexingMode

        ThingIndexingConfiguration.Builder thingConnectivityIndexingMode​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ThingConnectivityIndexingMode, ThingConnectivityIndexingMode

      • deviceDefenderIndexingMode

        ThingIndexingConfiguration.Builder deviceDefenderIndexingMode​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DeviceDefenderIndexingMode, DeviceDefenderIndexingMode

      • deviceDefenderIndexingMode

        ThingIndexingConfiguration.Builder deviceDefenderIndexingMode​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DeviceDefenderIndexingMode, DeviceDefenderIndexingMode

      • namedShadowIndexingMode

        ThingIndexingConfiguration.Builder namedShadowIndexingMode​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        NamedShadowIndexingMode, NamedShadowIndexingMode

      • namedShadowIndexingMode

        ThingIndexingConfiguration.Builder namedShadowIndexingMode​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        NamedShadowIndexingMode, NamedShadowIndexingMode

      • managedFields

        ThingIndexingConfiguration.Builder managedFields​(Collection<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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • managedFields

        ThingIndexingConfiguration.Builder managedFields​(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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • managedFields

        ThingIndexingConfiguration.Builder managedFields​(Consumer<Field.Builder>... 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.

        This is a convenience method that creates an instance of the Field.Builder avoiding the need to create one manually via Field.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #managedFields(List).

        Parameters:
        managedFields - a consumer that will call methods on Field.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #managedFields(java.util.Collection)

      • customFields

        ThingIndexingConfiguration.Builder customFields​(Collection<Field> customFields)

        Contains custom field names and their data type.

        Parameters:
        customFields - Contains custom field names and their data type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • customFields

        ThingIndexingConfiguration.Builder customFields​(Field... customFields)

        Contains custom field names and their data type.

        Parameters:
        customFields - Contains custom field names and their data type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • customFields

        ThingIndexingConfiguration.Builder customFields​(Consumer<Field.Builder>... customFields)

        Contains custom field names and their data type.

        This is a convenience method that creates an instance of the Field.Builder avoiding the need to create one manually via Field.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #customFields(List).

        Parameters:
        customFields - a consumer that will call methods on Field.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #customFields(java.util.Collection)

      • filter

        ThingIndexingConfiguration.Builder filter​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • filter

        default ThingIndexingConfiguration.Builder filter​(Consumer<IndexingFilter.Builder> 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.

        This is a convenience method that creates an instance of the IndexingFilter.Builder avoiding the need to create one manually via IndexingFilter.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filter(IndexingFilter).

        Parameters:
        filter - a consumer that will call methods on IndexingFilter.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        filter(IndexingFilter)