Struct ThingDocument

#[non_exhaustive]
pub struct ThingDocument {
    pub thing_name: Option<String>,
    pub thing_id: Option<String>,
    pub thing_type_name: Option<String>,
    pub thing_group_names: Option<Vec<String>>,
    pub attributes: Option<HashMap<String, String>>,
    pub shadow: Option<String>,
    pub device_defender: Option<String>,
    pub connectivity: Option<ThingConnectivity>,
}

The thing search index document.

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_name: Option<String>

The thing name.

thing_id: Option<String>

The thing ID.

thing_type_name: Option<String>

The thing type name.

thing_group_names: Option<Vec<String>>

Thing group and billing group names.

attributes: Option<HashMap<String, String>>

The attributes.

shadow: Option<String>

The unnamed shadow and named shadow.

For more information about shadows, see IoT Device Shadow service.

device_defender: Option<String>

Contains Device Defender data.

For more information about Device Defender, see Device Defender.

connectivity: Option<ThingConnectivity>

Indicates whether the thing is connected to the Amazon Web Services IoT Core service.

Implementations

impl ThingDocument

pub fn thing_name(&self) -> Option<&str>

The thing name.

pub fn thing_id(&self) -> Option<&str>

The thing ID.

pub fn thing_type_name(&self) -> Option<&str>

The thing type name.

pub fn thing_group_names(&self) -> &[String]

Thing group and billing group names.

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

pub fn attributes(&self) -> Option<&HashMap<String, String>>

The attributes.

pub fn shadow(&self) -> Option<&str>

The unnamed shadow and named shadow.

For more information about shadows, see IoT Device Shadow service.

pub fn device_defender(&self) -> Option<&str>

Contains Device Defender data.

For more information about Device Defender, see Device Defender.

pub fn connectivity(&self) -> Option<&ThingConnectivity>

Indicates whether the thing is connected to the Amazon Web Services IoT Core service.

impl ThingDocument

pub fn builder() -> ThingDocumentBuilder

Creates a new builder-style object to manufacture ThingDocument.

Trait Implementations

impl Clone for ThingDocument

fn clone(&self) -> ThingDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ThingDocument

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

Formats the value using the given formatter.

impl PartialEq for ThingDocument

fn eq(&self, other: &ThingDocument) -> 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 ThingDocument