#[non_exhaustive]pub struct ThingIndexingConfigurationBuilder { /* private fields */ }
Expand description
A builder for ThingIndexingConfiguration
.
Implementations§
Source§impl ThingIndexingConfigurationBuilder
impl ThingIndexingConfigurationBuilder
Sourcepub fn thing_indexing_mode(self, input: ThingIndexingMode) -> Self
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.
Sourcepub fn set_thing_indexing_mode(self, input: Option<ThingIndexingMode>) -> Self
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.
Sourcepub fn get_thing_indexing_mode(&self) -> &Option<ThingIndexingMode>
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.
Sourcepub fn thing_connectivity_indexing_mode(
self,
input: ThingConnectivityIndexingMode,
) -> Self
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.
Sourcepub fn set_thing_connectivity_indexing_mode(
self,
input: Option<ThingConnectivityIndexingMode>,
) -> Self
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.
Sourcepub fn get_thing_connectivity_indexing_mode(
&self,
) -> &Option<ThingConnectivityIndexingMode>
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.
Sourcepub fn device_defender_indexing_mode(
self,
input: DeviceDefenderIndexingMode,
) -> Self
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.
Sourcepub fn set_device_defender_indexing_mode(
self,
input: Option<DeviceDefenderIndexingMode>,
) -> Self
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.
Sourcepub fn get_device_defender_indexing_mode(
&self,
) -> &Option<DeviceDefenderIndexingMode>
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.
Sourcepub fn named_shadow_indexing_mode(self, input: NamedShadowIndexingMode) -> Self
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.
Sourcepub fn set_named_shadow_indexing_mode(
self,
input: Option<NamedShadowIndexingMode>,
) -> Self
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.
Sourcepub fn get_named_shadow_indexing_mode(&self) -> &Option<NamedShadowIndexingMode>
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.
Sourcepub fn managed_fields(self, input: Field) -> Self
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.
Sourcepub fn set_managed_fields(self, input: Option<Vec<Field>>) -> Self
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.
Sourcepub fn get_managed_fields(&self) -> &Option<Vec<Field>>
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.
Sourcepub fn custom_fields(self, input: Field) -> Self
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.
Sourcepub fn set_custom_fields(self, input: Option<Vec<Field>>) -> Self
pub fn set_custom_fields(self, input: Option<Vec<Field>>) -> Self
Contains custom field names and their data type.
Sourcepub fn get_custom_fields(&self) -> &Option<Vec<Field>>
pub fn get_custom_fields(&self) -> &Option<Vec<Field>>
Contains custom field names and their data type.
Sourcepub fn filter(self, input: IndexingFilter) -> Self
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 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.
Sourcepub fn set_filter(self, input: Option<IndexingFilter>) -> Self
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 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.
Sourcepub fn get_filter(&self) -> &Option<IndexingFilter>
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 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.
Sourcepub fn build(self) -> Result<ThingIndexingConfiguration, BuildError>
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:
Trait Implementations§
Source§impl Clone for ThingIndexingConfigurationBuilder
impl Clone for ThingIndexingConfigurationBuilder
Source§fn clone(&self) -> ThingIndexingConfigurationBuilder
fn clone(&self) -> ThingIndexingConfigurationBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for ThingIndexingConfigurationBuilder
impl Default for ThingIndexingConfigurationBuilder
Source§fn default() -> ThingIndexingConfigurationBuilder
fn default() -> ThingIndexingConfigurationBuilder
Source§impl PartialEq for ThingIndexingConfigurationBuilder
impl PartialEq for ThingIndexingConfigurationBuilder
Source§fn eq(&self, other: &ThingIndexingConfigurationBuilder) -> bool
fn eq(&self, other: &ThingIndexingConfigurationBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for ThingIndexingConfigurationBuilder
Auto Trait Implementations§
impl Freeze for ThingIndexingConfigurationBuilder
impl RefUnwindSafe for ThingIndexingConfigurationBuilder
impl Send for ThingIndexingConfigurationBuilder
impl Sync for ThingIndexingConfigurationBuilder
impl Unpin for ThingIndexingConfigurationBuilder
impl UnwindSafe for ThingIndexingConfigurationBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);