pub struct StartDeviceDiscoveryFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to StartDeviceDiscovery
.
This API is used to start device discovery for hub-connected and third-party-connected devices. The authentication material (install code) is passed as a message to the controller telling it to start the discovery.
Implementations§
Source§impl StartDeviceDiscoveryFluentBuilder
impl StartDeviceDiscoveryFluentBuilder
Sourcepub fn as_input(&self) -> &StartDeviceDiscoveryInputBuilder
pub fn as_input(&self) -> &StartDeviceDiscoveryInputBuilder
Access the StartDeviceDiscovery as a reference.
Sourcepub async fn send(
self,
) -> Result<StartDeviceDiscoveryOutput, SdkError<StartDeviceDiscoveryError, HttpResponse>>
pub async fn send( self, ) -> Result<StartDeviceDiscoveryOutput, SdkError<StartDeviceDiscoveryError, 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<StartDeviceDiscoveryOutput, StartDeviceDiscoveryError, Self>
pub fn customize( self, ) -> CustomizableOperation<StartDeviceDiscoveryOutput, StartDeviceDiscoveryError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn discovery_type(self, input: DiscoveryType) -> Self
pub fn discovery_type(self, input: DiscoveryType) -> Self
The discovery type supporting the type of device to be discovered in the device discovery task request.
Sourcepub fn set_discovery_type(self, input: Option<DiscoveryType>) -> Self
pub fn set_discovery_type(self, input: Option<DiscoveryType>) -> Self
The discovery type supporting the type of device to be discovered in the device discovery task request.
Sourcepub fn get_discovery_type(&self) -> &Option<DiscoveryType>
pub fn get_discovery_type(&self) -> &Option<DiscoveryType>
The discovery type supporting the type of device to be discovered in the device discovery task request.
Sourcepub fn custom_protocol_detail(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn custom_protocol_detail( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to CustomProtocolDetail
.
To override the contents of this collection use set_custom_protocol_detail
.
Additional protocol-specific details required for device discovery, which vary based on the discovery type.
For a DiscoveryType
of CUSTOM
, the string-to-string map must have a key value of Name
set to a non-empty-string.
Sourcepub fn set_custom_protocol_detail(
self,
input: Option<HashMap<String, String>>,
) -> Self
pub fn set_custom_protocol_detail( self, input: Option<HashMap<String, String>>, ) -> Self
Additional protocol-specific details required for device discovery, which vary based on the discovery type.
For a DiscoveryType
of CUSTOM
, the string-to-string map must have a key value of Name
set to a non-empty-string.
Sourcepub fn get_custom_protocol_detail(&self) -> &Option<HashMap<String, String>>
pub fn get_custom_protocol_detail(&self) -> &Option<HashMap<String, String>>
Additional protocol-specific details required for device discovery, which vary based on the discovery type.
For a DiscoveryType
of CUSTOM
, the string-to-string map must have a key value of Name
set to a non-empty-string.
Sourcepub fn controller_identifier(self, input: impl Into<String>) -> Self
pub fn controller_identifier(self, input: impl Into<String>) -> Self
The id of the end-user's IoT hub.
Sourcepub fn set_controller_identifier(self, input: Option<String>) -> Self
pub fn set_controller_identifier(self, input: Option<String>) -> Self
The id of the end-user's IoT hub.
Sourcepub fn get_controller_identifier(&self) -> &Option<String>
pub fn get_controller_identifier(&self) -> &Option<String>
The id of the end-user's IoT hub.
Sourcepub fn connector_association_identifier(self, input: impl Into<String>) -> Self
👎Deprecated since 06-25-2025: ConnectorAssociationIdentifier is deprecated
pub fn connector_association_identifier(self, input: impl Into<String>) -> Self
The id of the connector association.
Sourcepub fn set_connector_association_identifier(self, input: Option<String>) -> Self
👎Deprecated since 06-25-2025: ConnectorAssociationIdentifier is deprecated
pub fn set_connector_association_identifier(self, input: Option<String>) -> Self
The id of the connector association.
Sourcepub fn get_connector_association_identifier(&self) -> &Option<String>
👎Deprecated since 06-25-2025: ConnectorAssociationIdentifier is deprecated
pub fn get_connector_association_identifier(&self) -> &Option<String>
The id of the connector association.
Sourcepub fn account_association_id(self, input: impl Into<String>) -> Self
pub fn account_association_id(self, input: impl Into<String>) -> Self
The identifier of the cloud-to-cloud account association to use for discovery of third-party devices.
Sourcepub fn set_account_association_id(self, input: Option<String>) -> Self
pub fn set_account_association_id(self, input: Option<String>) -> Self
The identifier of the cloud-to-cloud account association to use for discovery of third-party devices.
Sourcepub fn get_account_association_id(&self) -> &Option<String>
pub fn get_account_association_id(&self) -> &Option<String>
The identifier of the cloud-to-cloud account association to use for discovery of third-party devices.
Sourcepub fn authentication_material(self, input: impl Into<String>) -> Self
pub fn authentication_material(self, input: impl Into<String>) -> Self
The authentication material required to start the local device discovery job request.
Sourcepub fn set_authentication_material(self, input: Option<String>) -> Self
pub fn set_authentication_material(self, input: Option<String>) -> Self
The authentication material required to start the local device discovery job request.
Sourcepub fn get_authentication_material(&self) -> &Option<String>
pub fn get_authentication_material(&self) -> &Option<String>
The authentication material required to start the local device discovery job request.
Sourcepub fn authentication_material_type(
self,
input: DiscoveryAuthMaterialType,
) -> Self
pub fn authentication_material_type( self, input: DiscoveryAuthMaterialType, ) -> Self
The type of authentication material used for device discovery jobs.
Sourcepub fn set_authentication_material_type(
self,
input: Option<DiscoveryAuthMaterialType>,
) -> Self
pub fn set_authentication_material_type( self, input: Option<DiscoveryAuthMaterialType>, ) -> Self
The type of authentication material used for device discovery jobs.
Sourcepub fn get_authentication_material_type(
&self,
) -> &Option<DiscoveryAuthMaterialType>
pub fn get_authentication_material_type( &self, ) -> &Option<DiscoveryAuthMaterialType>
The type of authentication material used for device discovery jobs.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
👎Deprecated since 06-25-2025: Tags have been deprecated from this api
Adds a key-value pair to Tags
.
To override the contents of this collection use set_tags
.
A set of key/value pairs that are used to manage the device discovery request.
👎Deprecated since 06-25-2025: Tags have been deprecated from this api
A set of key/value pairs that are used to manage the device discovery request.
👎Deprecated since 06-25-2025: Tags have been deprecated from this api
A set of key/value pairs that are used to manage the device discovery request.
Trait Implementations§
Source§impl Clone for StartDeviceDiscoveryFluentBuilder
impl Clone for StartDeviceDiscoveryFluentBuilder
Source§fn clone(&self) -> StartDeviceDiscoveryFluentBuilder
fn clone(&self) -> StartDeviceDiscoveryFluentBuilder
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 StartDeviceDiscoveryFluentBuilder
impl !RefUnwindSafe for StartDeviceDiscoveryFluentBuilder
impl Send for StartDeviceDiscoveryFluentBuilder
impl Sync for StartDeviceDiscoveryFluentBuilder
impl Unpin for StartDeviceDiscoveryFluentBuilder
impl !UnwindSafe for StartDeviceDiscoveryFluentBuilder
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);