#[non_exhaustive]pub struct GatewaySummaryBuilder { /* private fields */ }Expand description
A builder for GatewaySummary.
Implementations§
Source§impl GatewaySummaryBuilder
impl GatewaySummaryBuilder
Sourcepub fn gateway_id(self, input: impl Into<String>) -> Self
pub fn gateway_id(self, input: impl Into<String>) -> Self
The ID of the gateway device.
This field is required.Sourcepub fn set_gateway_id(self, input: Option<String>) -> Self
pub fn set_gateway_id(self, input: Option<String>) -> Self
The ID of the gateway device.
Sourcepub fn get_gateway_id(&self) -> &Option<String>
pub fn get_gateway_id(&self) -> &Option<String>
The ID of the gateway device.
Sourcepub fn gateway_name(self, input: impl Into<String>) -> Self
pub fn gateway_name(self, input: impl Into<String>) -> Self
The name of the gateway.
This field is required.Sourcepub fn set_gateway_name(self, input: Option<String>) -> Self
pub fn set_gateway_name(self, input: Option<String>) -> Self
The name of the gateway.
Sourcepub fn get_gateway_name(&self) -> &Option<String>
pub fn get_gateway_name(&self) -> &Option<String>
The name of the gateway.
Sourcepub fn gateway_platform(self, input: GatewayPlatform) -> Self
pub fn gateway_platform(self, input: GatewayPlatform) -> Self
The gateway's platform configuration. You can only specify one platform type in a gateway.
(Legacy only) For Greengrass V1 gateways, specify the greengrass parameter with a valid Greengrass group ARN.
For Greengrass V2 gateways, specify the greengrassV2 parameter with a valid core device thing name. If creating a V3 gateway (gatewayVersion=3), you must also specify the coreDeviceOperatingSystem.
For Siemens Industrial Edge gateways, specify the siemensIE parameter with a valid IoT Core thing name.
Sourcepub fn set_gateway_platform(self, input: Option<GatewayPlatform>) -> Self
pub fn set_gateway_platform(self, input: Option<GatewayPlatform>) -> Self
The gateway's platform configuration. You can only specify one platform type in a gateway.
(Legacy only) For Greengrass V1 gateways, specify the greengrass parameter with a valid Greengrass group ARN.
For Greengrass V2 gateways, specify the greengrassV2 parameter with a valid core device thing name. If creating a V3 gateway (gatewayVersion=3), you must also specify the coreDeviceOperatingSystem.
For Siemens Industrial Edge gateways, specify the siemensIE parameter with a valid IoT Core thing name.
Sourcepub fn get_gateway_platform(&self) -> &Option<GatewayPlatform>
pub fn get_gateway_platform(&self) -> &Option<GatewayPlatform>
The gateway's platform configuration. You can only specify one platform type in a gateway.
(Legacy only) For Greengrass V1 gateways, specify the greengrass parameter with a valid Greengrass group ARN.
For Greengrass V2 gateways, specify the greengrassV2 parameter with a valid core device thing name. If creating a V3 gateway (gatewayVersion=3), you must also specify the coreDeviceOperatingSystem.
For Siemens Industrial Edge gateways, specify the siemensIE parameter with a valid IoT Core thing name.
Sourcepub fn gateway_version(self, input: impl Into<String>) -> Self
pub fn gateway_version(self, input: impl Into<String>) -> Self
The version of the gateway. A value of 3 indicates an MQTT-enabled, V3 gateway, while 2 indicates a Classic streams, V2 gateway.
Sourcepub fn set_gateway_version(self, input: Option<String>) -> Self
pub fn set_gateway_version(self, input: Option<String>) -> Self
The version of the gateway. A value of 3 indicates an MQTT-enabled, V3 gateway, while 2 indicates a Classic streams, V2 gateway.
Sourcepub fn get_gateway_version(&self) -> &Option<String>
pub fn get_gateway_version(&self) -> &Option<String>
The version of the gateway. A value of 3 indicates an MQTT-enabled, V3 gateway, while 2 indicates a Classic streams, V2 gateway.
Sourcepub fn gateway_capability_summaries(
self,
input: GatewayCapabilitySummary,
) -> Self
pub fn gateway_capability_summaries( self, input: GatewayCapabilitySummary, ) -> Self
Appends an item to gateway_capability_summaries.
To override the contents of this collection use set_gateway_capability_summaries.
A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.
Sourcepub fn set_gateway_capability_summaries(
self,
input: Option<Vec<GatewayCapabilitySummary>>,
) -> Self
pub fn set_gateway_capability_summaries( self, input: Option<Vec<GatewayCapabilitySummary>>, ) -> Self
A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.
Sourcepub fn get_gateway_capability_summaries(
&self,
) -> &Option<Vec<GatewayCapabilitySummary>>
pub fn get_gateway_capability_summaries( &self, ) -> &Option<Vec<GatewayCapabilitySummary>>
A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.
Sourcepub fn creation_date(self, input: DateTime) -> Self
pub fn creation_date(self, input: DateTime) -> Self
The date the gateway was created, in Unix epoch time.
This field is required.Sourcepub fn set_creation_date(self, input: Option<DateTime>) -> Self
pub fn set_creation_date(self, input: Option<DateTime>) -> Self
The date the gateway was created, in Unix epoch time.
Sourcepub fn get_creation_date(&self) -> &Option<DateTime>
pub fn get_creation_date(&self) -> &Option<DateTime>
The date the gateway was created, in Unix epoch time.
Sourcepub fn last_update_date(self, input: DateTime) -> Self
pub fn last_update_date(self, input: DateTime) -> Self
The date the gateway was last updated, in Unix epoch time.
This field is required.Sourcepub fn set_last_update_date(self, input: Option<DateTime>) -> Self
pub fn set_last_update_date(self, input: Option<DateTime>) -> Self
The date the gateway was last updated, in Unix epoch time.
Sourcepub fn get_last_update_date(&self) -> &Option<DateTime>
pub fn get_last_update_date(&self) -> &Option<DateTime>
The date the gateway was last updated, in Unix epoch time.
Sourcepub fn build(self) -> Result<GatewaySummary, BuildError>
pub fn build(self) -> Result<GatewaySummary, BuildError>
Consumes the builder and constructs a GatewaySummary.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for GatewaySummaryBuilder
impl Clone for GatewaySummaryBuilder
Source§fn clone(&self) -> GatewaySummaryBuilder
fn clone(&self) -> GatewaySummaryBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for GatewaySummaryBuilder
impl Debug for GatewaySummaryBuilder
Source§impl Default for GatewaySummaryBuilder
impl Default for GatewaySummaryBuilder
Source§fn default() -> GatewaySummaryBuilder
fn default() -> GatewaySummaryBuilder
Source§impl PartialEq for GatewaySummaryBuilder
impl PartialEq for GatewaySummaryBuilder
impl StructuralPartialEq for GatewaySummaryBuilder
Auto Trait Implementations§
impl Freeze for GatewaySummaryBuilder
impl RefUnwindSafe for GatewaySummaryBuilder
impl Send for GatewaySummaryBuilder
impl Sync for GatewaySummaryBuilder
impl Unpin for GatewaySummaryBuilder
impl UnwindSafe for GatewaySummaryBuilder
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);