Class ThingIndexingConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ThingIndexingConfiguration.Builder,
ThingIndexingConfiguration>
The thing indexing configuration. For more information, see Managing Thing Indexing.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Contains custom field names and their data type.Device Defender indexing mode.final String
Device Defender indexing mode.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final IndexingFilter
filter()
Provides additional selections for named shadows and geolocation data.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the CustomFields property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ManagedFields property.Contains fields that are indexed and whose types are already known by the Fleet Indexing service.final NamedShadowIndexingMode
Named shadow indexing mode.final String
Named shadow indexing mode.static Class
<? extends ThingIndexingConfiguration.Builder> Thing connectivity indexing mode.final String
Thing connectivity indexing mode.final ThingIndexingMode
Thing indexing mode.final String
Thing indexing mode.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnThingIndexingMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromthingIndexingModeAsString()
.- 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
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 returnThingIndexingMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromthingIndexingModeAsString()
.- 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
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 returnThingConnectivityIndexingMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromthingConnectivityIndexingModeAsString()
.- 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
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 returnThingConnectivityIndexingMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromthingConnectivityIndexingModeAsString()
.- 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
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 returnDeviceDefenderIndexingMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeviceDefenderIndexingModeAsString()
.- 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
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 returnDeviceDefenderIndexingMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeviceDefenderIndexingModeAsString()
.- 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
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 returnNamedShadowIndexingMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnamedShadowIndexingModeAsString()
.- 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
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 returnNamedShadowIndexingMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnamedShadowIndexingModeAsString()
.- 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 theisEmpty()
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
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 theisEmpty()
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
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
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 innamedShadowNames
filter.To add geolocation data to your fleet indexing configuration:
-
If you store geolocation data in a class/unnamed shadow, set
thingIndexingMode
to beREGISTRY_AND_SHADOW
and specify your geolocation data ingeoLocations
filter. -
If you store geolocation data in a named shadow, set
namedShadowIndexingMode
to beON
, add the shadow name innamedShadowNames
filter, and specify your geolocation data ingeoLocations
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 innamedShadowNames
filter.To add geolocation data to your fleet indexing configuration:
-
If you store geolocation data in a class/unnamed shadow, set
thingIndexingMode
to beREGISTRY_AND_SHADOW
and specify your geolocation data ingeoLocations
filter. -
If you store geolocation data in a named shadow, set
namedShadowIndexingMode
to beON
, add the shadow name innamedShadowNames
filter, and specify your geolocation data ingeoLocations
filter. For more information, see Managing fleet indexing.
-
-
-
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 interfaceToCopyableBuilder<ThingIndexingConfiguration.Builder,
ThingIndexingConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-