Struct aws_sdk_iot::types::builders::ThingIndexingConfigurationBuilder

#[non_exhaustive]
pub struct ThingIndexingConfigurationBuilder { /* private fields */ }

A builder for ThingIndexingConfiguration.

Implementations

impl ThingIndexingConfigurationBuilder

pub fn thing_indexing_mode(self, input: ThingIndexingMode) -> Self

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.

This field is required.

pub fn set_thing_indexing_mode(self, input: Option<ThingIndexingMode>) -> Self

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.

pub fn get_thing_indexing_mode(&self) -> &Option<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.

pub fn thing_connectivity_indexing_mode( self, input: ThingConnectivityIndexingMode ) -> Self

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.

pub fn set_thing_connectivity_indexing_mode( self, input: Option<ThingConnectivityIndexingMode> ) -> Self

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.

pub fn get_thing_connectivity_indexing_mode( &self ) -> &Option<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.

pub fn device_defender_indexing_mode( self, input: DeviceDefenderIndexingMode ) -> Self

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.

pub fn set_device_defender_indexing_mode( self, input: Option<DeviceDefenderIndexingMode> ) -> Self

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.

pub fn get_device_defender_indexing_mode( &self ) -> &Option<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.

pub fn named_shadow_indexing_mode(self, input: NamedShadowIndexingMode) -> Self

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.

pub fn set_named_shadow_indexing_mode( self, input: Option<NamedShadowIndexingMode> ) -> Self

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.

pub fn get_named_shadow_indexing_mode(&self) -> &Option<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.

pub fn managed_fields(self, input: Field) -> Self

Appends an item to managed_fields.

To override the contents of this collection use set_managed_fields.

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.

pub fn set_managed_fields(self, input: Option<Vec<Field>>) -> Self

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.

pub fn get_managed_fields(&self) -> &Option<Vec<Field>>

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.

pub fn custom_fields(self, input: Field) -> Self

Appends an item to custom_fields.

To override the contents of this collection use set_custom_fields.

Contains custom field names and their data type.

pub fn set_custom_fields(self, input: Option<Vec<Field>>) -> Self

Contains custom field names and their data type.

pub fn get_custom_fields(&self) -> &Option<Vec<Field>>

Contains custom field names and their data type.

pub fn filter(self, input: IndexingFilter) -> Self

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.

pub fn set_filter(self, input: Option<IndexingFilter>) -> Self

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.

pub fn get_filter(&self) -> &Option<IndexingFilter>

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.

pub fn build(self) -> Result<ThingIndexingConfiguration, BuildError>

Consumes the builder and constructs a ThingIndexingConfiguration. This method will fail if any of the following fields are not set:

• thing_indexing_mode

Trait Implementations

impl Clone for ThingIndexingConfigurationBuilder

fn clone(&self) -> ThingIndexingConfigurationBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ThingIndexingConfigurationBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ThingIndexingConfigurationBuilder

fn default() -> ThingIndexingConfigurationBuilder

Returns the “default value” for a type.

impl PartialEq for ThingIndexingConfigurationBuilder

fn eq(&self, other: &ThingIndexingConfigurationBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ThingIndexingConfigurationBuilder