#[non_exhaustive]pub struct SendConnectorEventInput {
pub connector_id: Option<String>,
pub user_id: Option<String>,
pub operation: Option<ConnectorEventOperation>,
pub operation_version: Option<String>,
pub status_code: Option<i32>,
pub message: Option<String>,
pub device_discovery_id: Option<String>,
pub connector_device_id: Option<String>,
pub trace_id: Option<String>,
pub devices: Option<Vec<Device>>,
pub matter_endpoint: Option<MatterEndpoint>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.connector_id: Option<String>
The id of the connector between the third-party cloud provider and IoT managed integrations.
user_id: Option<String>
The id of the third-party cloud provider.
operation: 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.
operation_version: 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.
status_code: Option<i32>
The status code of the Open Connectivity Foundation (OCF) operation being performed on the managed thing.
message: Option<String>
The device state change event payload.
This parameter will include the following three fields:
-
uri
:schema auc://<PARTNER-DEVICE-ID>/ResourcePath
(TheResourcepath
corresponds 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
.
device_discovery_id: Option<String>
The id for the device discovery job.
connector_device_id: 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.
trace_id: Option<String>
The trace request identifier used to correlate a command request and response. This is specified by the device owner, but will be generated by IoT managed integrations if not provided by the device owner.
devices: Option<Vec<Device>>
The list of devices.
matter_endpoint: Option<MatterEndpoint>
The device endpoint.
Implementations§
Source§impl SendConnectorEventInput
impl SendConnectorEventInput
Sourcepub fn connector_id(&self) -> Option<&str>
pub fn connector_id(&self) -> Option<&str>
The id of the connector between the third-party cloud provider and IoT managed integrations.
Sourcepub fn operation(&self) -> Option<&ConnectorEventOperation>
pub fn 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) -> Option<&str>
pub fn operation_version(&self) -> Option<&str>
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) -> Option<i32>
pub fn 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) -> Option<&str>
pub fn message(&self) -> Option<&str>
The device state change event payload.
This parameter will include the following three fields:
-
uri
:schema auc://<PARTNER-DEVICE-ID>/ResourcePath
(TheResourcepath
corresponds 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) -> Option<&str>
pub fn device_discovery_id(&self) -> Option<&str>
The id for the device discovery job.
Sourcepub fn connector_device_id(&self) -> Option<&str>
pub fn connector_device_id(&self) -> Option<&str>
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) -> Option<&str>
pub fn trace_id(&self) -> Option<&str>
The trace request identifier used to correlate a command request and response. This is specified by the device owner, but will be generated by IoT managed integrations if not provided by the device owner.
Sourcepub fn devices(&self) -> &[Device]
pub fn devices(&self) -> &[Device]
The list of devices.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .devices.is_none()
.
Sourcepub fn matter_endpoint(&self) -> Option<&MatterEndpoint>
pub fn matter_endpoint(&self) -> Option<&MatterEndpoint>
The device endpoint.
Source§impl SendConnectorEventInput
impl SendConnectorEventInput
Sourcepub fn builder() -> SendConnectorEventInputBuilder
pub fn builder() -> SendConnectorEventInputBuilder
Creates a new builder-style object to manufacture SendConnectorEventInput
.
Trait Implementations§
Source§impl Clone for SendConnectorEventInput
impl Clone for SendConnectorEventInput
Source§fn clone(&self) -> SendConnectorEventInput
fn clone(&self) -> SendConnectorEventInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for SendConnectorEventInput
impl Debug for SendConnectorEventInput
Source§impl PartialEq for SendConnectorEventInput
impl PartialEq for SendConnectorEventInput
impl StructuralPartialEq for SendConnectorEventInput
Auto Trait Implementations§
impl Freeze for SendConnectorEventInput
impl RefUnwindSafe for SendConnectorEventInput
impl Send for SendConnectorEventInput
impl Sync for SendConnectorEventInput
impl Unpin for SendConnectorEventInput
impl UnwindSafe for SendConnectorEventInput
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);