Struct ThingGroupIndexingConfiguration

#[non_exhaustive]
pub struct ThingGroupIndexingConfiguration {
    pub thing_group_indexing_mode: ThingGroupIndexingMode,
    pub managed_fields: Option<Vec<Field>>,
    pub custom_fields: Option<Vec<Field>>,
}

Thing group indexing configuration.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

thing_group_indexing_mode: ThingGroupIndexingMode

Thing group indexing mode.

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

custom_fields: Option<Vec<Field>>

A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.

Contains custom field names and their data type.

Implementations

impl ThingGroupIndexingConfiguration

pub fn thing_group_indexing_mode(&self) -> &ThingGroupIndexingMode

Thing group indexing mode.

pub fn managed_fields(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .managed_fields.is_none().

pub fn custom_fields(&self) -> &[Field]

A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.

Contains custom field names and their data type.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .custom_fields.is_none().

impl ThingGroupIndexingConfiguration

pub fn builder() -> ThingGroupIndexingConfigurationBuilder

Creates a new builder-style object to manufacture ThingGroupIndexingConfiguration.

Trait Implementations

impl Clone for ThingGroupIndexingConfiguration

fn clone(&self) -> ThingGroupIndexingConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ThingGroupIndexingConfiguration

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

Formats the value using the given formatter.

impl PartialEq for ThingGroupIndexingConfiguration

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ThingGroupIndexingConfiguration