@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ThingIndexingConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
The thing indexing configuration. For more information, see Managing Thing Indexing.
| Constructor and Description |
|---|
ThingIndexingConfiguration() |
| Modifier and Type | Method and Description |
|---|---|
ThingIndexingConfiguration |
clone() |
boolean |
equals(Object obj) |
List<Field> |
getCustomFields()
Contains custom field names and their data type.
|
String |
getDeviceDefenderIndexingMode()
Device Defender indexing mode.
|
IndexingFilter |
getFilter()
Provides additional selections for named shadows and geolocation data.
|
List<Field> |
getManagedFields()
Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
|
String |
getNamedShadowIndexingMode()
Named shadow indexing mode.
|
String |
getThingConnectivityIndexingMode()
Thing connectivity indexing mode.
|
String |
getThingIndexingMode()
Thing indexing mode.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller. |
void |
setCustomFields(Collection<Field> customFields)
Contains custom field names and their data type.
|
void |
setDeviceDefenderIndexingMode(String deviceDefenderIndexingMode)
Device Defender indexing mode.
|
void |
setFilter(IndexingFilter filter)
Provides additional selections for named shadows and geolocation data.
|
void |
setManagedFields(Collection<Field> managedFields)
Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
|
void |
setNamedShadowIndexingMode(String namedShadowIndexingMode)
Named shadow indexing mode.
|
void |
setThingConnectivityIndexingMode(String thingConnectivityIndexingMode)
Thing connectivity indexing mode.
|
void |
setThingIndexingMode(String thingIndexingMode)
Thing indexing mode.
|
String |
toString()
Returns a string representation of this object.
|
ThingIndexingConfiguration |
withCustomFields(Collection<Field> customFields)
Contains custom field names and their data type.
|
ThingIndexingConfiguration |
withCustomFields(Field... customFields)
Contains custom field names and their data type.
|
ThingIndexingConfiguration |
withDeviceDefenderIndexingMode(DeviceDefenderIndexingMode deviceDefenderIndexingMode)
Device Defender indexing mode.
|
ThingIndexingConfiguration |
withDeviceDefenderIndexingMode(String deviceDefenderIndexingMode)
Device Defender indexing mode.
|
ThingIndexingConfiguration |
withFilter(IndexingFilter filter)
Provides additional selections for named shadows and geolocation data.
|
ThingIndexingConfiguration |
withManagedFields(Collection<Field> managedFields)
Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
|
ThingIndexingConfiguration |
withManagedFields(Field... managedFields)
Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
|
ThingIndexingConfiguration |
withNamedShadowIndexingMode(NamedShadowIndexingMode namedShadowIndexingMode)
Named shadow indexing mode.
|
ThingIndexingConfiguration |
withNamedShadowIndexingMode(String namedShadowIndexingMode)
Named shadow indexing mode.
|
ThingIndexingConfiguration |
withThingConnectivityIndexingMode(String thingConnectivityIndexingMode)
Thing connectivity indexing mode.
|
ThingIndexingConfiguration |
withThingConnectivityIndexingMode(ThingConnectivityIndexingMode thingConnectivityIndexingMode)
Thing connectivity indexing mode.
|
ThingIndexingConfiguration |
withThingIndexingMode(String thingIndexingMode)
Thing indexing mode.
|
ThingIndexingConfiguration |
withThingIndexingMode(ThingIndexingMode thingIndexingMode)
Thing indexing mode.
|
public void setThingIndexingMode(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.
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.
ThingIndexingModepublic String getThingIndexingMode()
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.
REGISTRY – Your thing index contains registry data only.
REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.
OFF - Thing indexing is disabled.
ThingIndexingModepublic ThingIndexingConfiguration withThingIndexingMode(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.
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.
ThingIndexingModepublic ThingIndexingConfiguration withThingIndexingMode(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.
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.
ThingIndexingModepublic void setThingConnectivityIndexingMode(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.
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.
ThingConnectivityIndexingModepublic String getThingConnectivityIndexingMode()
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.
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.
ThingConnectivityIndexingModepublic ThingIndexingConfiguration withThingConnectivityIndexingMode(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.
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.
ThingConnectivityIndexingModepublic ThingIndexingConfiguration withThingConnectivityIndexingMode(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.
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.
ThingConnectivityIndexingModepublic void setDeviceDefenderIndexingMode(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.
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.
DeviceDefenderIndexingModepublic String getDeviceDefenderIndexingMode()
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.
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.
DeviceDefenderIndexingModepublic ThingIndexingConfiguration withDeviceDefenderIndexingMode(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.
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.
DeviceDefenderIndexingModepublic ThingIndexingConfiguration withDeviceDefenderIndexingMode(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.
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.
DeviceDefenderIndexingModepublic void setNamedShadowIndexingMode(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.
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.
NamedShadowIndexingModepublic String getNamedShadowIndexingMode()
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.
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.
NamedShadowIndexingModepublic ThingIndexingConfiguration withNamedShadowIndexingMode(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.
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.
NamedShadowIndexingModepublic ThingIndexingConfiguration withNamedShadowIndexingMode(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.
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.
NamedShadowIndexingModepublic List<Field> getManagedFields()
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.
You can't modify managed fields by updating fleet indexing configuration.
public void setManagedFields(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.
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.
public ThingIndexingConfiguration withManagedFields(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.
NOTE: This method appends the values to the existing list (if any). Use
setManagedFields(java.util.Collection) or withManagedFields(java.util.Collection) if you want
to override the existing values.
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.
public ThingIndexingConfiguration withManagedFields(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.
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.
public List<Field> getCustomFields()
Contains custom field names and their data type.
public void setCustomFields(Collection<Field> customFields)
Contains custom field names and their data type.
customFields - Contains custom field names and their data type.public ThingIndexingConfiguration withCustomFields(Field... customFields)
Contains custom field names and their data type.
NOTE: This method appends the values to the existing list (if any). Use
setCustomFields(java.util.Collection) or withCustomFields(java.util.Collection) if you want to
override the existing values.
customFields - Contains custom field names and their data type.public ThingIndexingConfiguration withCustomFields(Collection<Field> customFields)
Contains custom field names and their data type.
customFields - Contains custom field names and their data type.public void setFilter(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.
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.
public IndexingFilter getFilter()
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.
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.
public ThingIndexingConfiguration withFilter(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.
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.
public String toString()
toString in class ObjectObject.toString()public ThingIndexingConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.