pub struct SendConnectorEventFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to SendConnectorEvent.
Relays third-party device events for a connector such as a new device or a device state change event.
Implementations§
Source§impl SendConnectorEventFluentBuilder
impl SendConnectorEventFluentBuilder
Sourcepub fn as_input(&self) -> &SendConnectorEventInputBuilder
pub fn as_input(&self) -> &SendConnectorEventInputBuilder
Access the SendConnectorEvent as a reference.
Sourcepub async fn send(
self,
) -> Result<SendConnectorEventOutput, SdkError<SendConnectorEventError, HttpResponse>>
pub async fn send( self, ) -> Result<SendConnectorEventOutput, SdkError<SendConnectorEventError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<SendConnectorEventOutput, SendConnectorEventError, Self>
pub fn customize( self, ) -> CustomizableOperation<SendConnectorEventOutput, SendConnectorEventError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn connector_id(self, input: impl Into<String>) -> Self
pub fn connector_id(self, input: impl Into<String>) -> Self
The id of the connector between the third-party cloud provider and IoT managed integrations.
Sourcepub fn set_connector_id(self, input: Option<String>) -> Self
pub fn set_connector_id(self, input: Option<String>) -> Self
The id of the connector between the third-party cloud provider and IoT managed integrations.
Sourcepub fn get_connector_id(&self) -> &Option<String>
pub fn get_connector_id(&self) -> &Option<String>
The id of the connector between the third-party cloud provider and IoT managed integrations.
Sourcepub fn user_id(self, input: impl Into<String>) -> Self
pub fn user_id(self, input: impl Into<String>) -> Self
The id of the third-party cloud provider.
Sourcepub fn set_user_id(self, input: Option<String>) -> Self
pub fn set_user_id(self, input: Option<String>) -> Self
The id of the third-party cloud provider.
Sourcepub fn get_user_id(&self) -> &Option<String>
pub fn get_user_id(&self) -> &Option<String>
The id of the third-party cloud provider.
Sourcepub fn operation(self, input: ConnectorEventOperation) -> Self
pub fn operation(self, input: ConnectorEventOperation) -> Self
The Open Connectivity Foundation (OCF) operation requested to be performed on the managed thing.
The field op can have a value of "I" or "U". The field "cn" will contain the capability types.
Sourcepub fn set_operation(self, input: Option<ConnectorEventOperation>) -> Self
pub fn set_operation(self, input: Option<ConnectorEventOperation>) -> Self
The Open Connectivity Foundation (OCF) operation requested to be performed on the managed thing.
The field op can have a value of "I" or "U". The field "cn" will contain the capability types.
Sourcepub fn get_operation(&self) -> &Option<ConnectorEventOperation>
pub fn get_operation(&self) -> &Option<ConnectorEventOperation>
The Open Connectivity Foundation (OCF) operation requested to be performed on the managed thing.
The field op can have a value of "I" or "U". The field "cn" will contain the capability types.
Sourcepub fn operation_version(self, input: impl Into<String>) -> Self
pub fn operation_version(self, input: impl Into<String>) -> Self
The Open Connectivity Foundation (OCF) security specification version for the operation being requested on the managed thing. For more information, see OCF Security Specification.
Sourcepub fn set_operation_version(self, input: Option<String>) -> Self
pub fn set_operation_version(self, input: Option<String>) -> Self
The Open Connectivity Foundation (OCF) security specification version for the operation being requested on the managed thing. For more information, see OCF Security Specification.
Sourcepub fn get_operation_version(&self) -> &Option<String>
pub fn get_operation_version(&self) -> &Option<String>
The Open Connectivity Foundation (OCF) security specification version for the operation being requested on the managed thing. For more information, see OCF Security Specification.
Sourcepub fn status_code(self, input: i32) -> Self
pub fn status_code(self, input: i32) -> Self
The status code of the Open Connectivity Foundation (OCF) operation being performed on the managed thing.
Sourcepub fn set_status_code(self, input: Option<i32>) -> Self
pub fn set_status_code(self, input: Option<i32>) -> Self
The status code of the Open Connectivity Foundation (OCF) operation being performed on the managed thing.
Sourcepub fn get_status_code(&self) -> &Option<i32>
pub fn get_status_code(&self) -> &Option<i32>
The status code of the Open Connectivity Foundation (OCF) operation being performed on the managed thing.
Sourcepub fn message(self, input: impl Into<String>) -> Self
pub fn message(self, input: impl Into<String>) -> Self
The device state change event payload.
This parameter will include the following three fields:
-
uri:schema auc://<PARTNER-DEVICE-ID>/ResourcePath(TheResourcepathcorresponds to an OCF resource.) -
op: For device state changes, this field must populate asn+d. -
cn: The content depends on the OCF resource referenced inResourcePath.
Sourcepub fn set_message(self, input: Option<String>) -> Self
pub fn set_message(self, input: Option<String>) -> Self
The device state change event payload.
This parameter will include the following three fields:
-
uri:schema auc://<PARTNER-DEVICE-ID>/ResourcePath(TheResourcepathcorresponds to an OCF resource.) -
op: For device state changes, this field must populate asn+d. -
cn: The content depends on the OCF resource referenced inResourcePath.
Sourcepub fn get_message(&self) -> &Option<String>
pub fn get_message(&self) -> &Option<String>
The device state change event payload.
This parameter will include the following three fields:
-
uri:schema auc://<PARTNER-DEVICE-ID>/ResourcePath(TheResourcepathcorresponds to an OCF resource.) -
op: For device state changes, this field must populate asn+d. -
cn: The content depends on the OCF resource referenced inResourcePath.
Sourcepub fn device_discovery_id(self, input: impl Into<String>) -> Self
pub fn device_discovery_id(self, input: impl Into<String>) -> Self
The id for the device discovery job.
Sourcepub fn set_device_discovery_id(self, input: Option<String>) -> Self
pub fn set_device_discovery_id(self, input: Option<String>) -> Self
The id for the device discovery job.
Sourcepub fn get_device_discovery_id(&self) -> &Option<String>
pub fn get_device_discovery_id(&self) -> &Option<String>
The id for the device discovery job.
Sourcepub fn connector_device_id(self, input: impl Into<String>) -> Self
pub fn connector_device_id(self, input: impl Into<String>) -> Self
The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).
This parameter is used for cloud-to-cloud devices only.
Sourcepub fn set_connector_device_id(self, input: Option<String>) -> Self
pub fn set_connector_device_id(self, input: Option<String>) -> Self
The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).
This parameter is used for cloud-to-cloud devices only.
Sourcepub fn get_connector_device_id(&self) -> &Option<String>
pub fn get_connector_device_id(&self) -> &Option<String>
The third-party device id as defined by the connector. This device id must not contain personal identifiable information (PII).
This parameter is used for cloud-to-cloud devices only.
Sourcepub fn trace_id(self, input: impl Into<String>) -> Self
pub fn trace_id(self, input: impl Into<String>) -> Self
The trace request identifier. This is generated by IoT managed integrations and can be used to trace this command and its related operations in CloudWatch.
Sourcepub fn set_trace_id(self, input: Option<String>) -> Self
pub fn set_trace_id(self, input: Option<String>) -> Self
The trace request identifier. This is generated by IoT managed integrations and can be used to trace this command and its related operations in CloudWatch.
Sourcepub fn get_trace_id(&self) -> &Option<String>
pub fn get_trace_id(&self) -> &Option<String>
The trace request identifier. This is generated by IoT managed integrations and can be used to trace this command and its related operations in CloudWatch.
Sourcepub fn devices(self, input: Device) -> Self
pub fn devices(self, input: Device) -> Self
Appends an item to Devices.
To override the contents of this collection use set_devices.
The list of devices.
Sourcepub fn set_devices(self, input: Option<Vec<Device>>) -> Self
pub fn set_devices(self, input: Option<Vec<Device>>) -> Self
The list of devices.
Sourcepub fn get_devices(&self) -> &Option<Vec<Device>>
pub fn get_devices(&self) -> &Option<Vec<Device>>
The list of devices.
Sourcepub fn matter_endpoint(self, input: MatterEndpoint) -> Self
pub fn matter_endpoint(self, input: MatterEndpoint) -> Self
The device endpoint.
Sourcepub fn set_matter_endpoint(self, input: Option<MatterEndpoint>) -> Self
pub fn set_matter_endpoint(self, input: Option<MatterEndpoint>) -> Self
The device endpoint.
Sourcepub fn get_matter_endpoint(&self) -> &Option<MatterEndpoint>
pub fn get_matter_endpoint(&self) -> &Option<MatterEndpoint>
The device endpoint.
Trait Implementations§
Source§impl Clone for SendConnectorEventFluentBuilder
impl Clone for SendConnectorEventFluentBuilder
Source§fn clone(&self) -> SendConnectorEventFluentBuilder
fn clone(&self) -> SendConnectorEventFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for SendConnectorEventFluentBuilder
impl !RefUnwindSafe for SendConnectorEventFluentBuilder
impl Send for SendConnectorEventFluentBuilder
impl Sync for SendConnectorEventFluentBuilder
impl Unpin for SendConnectorEventFluentBuilder
impl !UnwindSafe for SendConnectorEventFluentBuilder
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);