pub struct InvokeScreenAutomationFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to InvokeScreenAutomation
.
The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app. The API allows setting local variables, which can then be used in the automation being invoked. This allows automating the Honeycode app interactions to write, update or delete data in the workbook.
Implementations§
Source§impl InvokeScreenAutomationFluentBuilder
impl InvokeScreenAutomationFluentBuilder
Sourcepub fn as_input(&self) -> &InvokeScreenAutomationInputBuilder
pub fn as_input(&self) -> &InvokeScreenAutomationInputBuilder
Access the InvokeScreenAutomation as a reference.
Sourcepub async fn send(
self,
) -> Result<InvokeScreenAutomationOutput, SdkError<InvokeScreenAutomationError, HttpResponse>>
pub async fn send( self, ) -> Result<InvokeScreenAutomationOutput, SdkError<InvokeScreenAutomationError, 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<InvokeScreenAutomationOutput, InvokeScreenAutomationError, Self>
pub fn customize( self, ) -> CustomizableOperation<InvokeScreenAutomationOutput, InvokeScreenAutomationError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn workbook_id(self, input: impl Into<String>) -> Self
pub fn workbook_id(self, input: impl Into<String>) -> Self
The ID of the workbook that contains the screen automation.
Sourcepub fn set_workbook_id(self, input: Option<String>) -> Self
pub fn set_workbook_id(self, input: Option<String>) -> Self
The ID of the workbook that contains the screen automation.
Sourcepub fn get_workbook_id(&self) -> &Option<String>
pub fn get_workbook_id(&self) -> &Option<String>
The ID of the workbook that contains the screen automation.
Sourcepub fn app_id(self, input: impl Into<String>) -> Self
pub fn app_id(self, input: impl Into<String>) -> Self
The ID of the app that contains the screen automation.
Sourcepub fn set_app_id(self, input: Option<String>) -> Self
pub fn set_app_id(self, input: Option<String>) -> Self
The ID of the app that contains the screen automation.
Sourcepub fn get_app_id(&self) -> &Option<String>
pub fn get_app_id(&self) -> &Option<String>
The ID of the app that contains the screen automation.
Sourcepub fn screen_id(self, input: impl Into<String>) -> Self
pub fn screen_id(self, input: impl Into<String>) -> Self
The ID of the screen that contains the screen automation.
Sourcepub fn set_screen_id(self, input: Option<String>) -> Self
pub fn set_screen_id(self, input: Option<String>) -> Self
The ID of the screen that contains the screen automation.
Sourcepub fn get_screen_id(&self) -> &Option<String>
pub fn get_screen_id(&self) -> &Option<String>
The ID of the screen that contains the screen automation.
Sourcepub fn screen_automation_id(self, input: impl Into<String>) -> Self
pub fn screen_automation_id(self, input: impl Into<String>) -> Self
The ID of the automation action to be performed.
Sourcepub fn set_screen_automation_id(self, input: Option<String>) -> Self
pub fn set_screen_automation_id(self, input: Option<String>) -> Self
The ID of the automation action to be performed.
Sourcepub fn get_screen_automation_id(&self) -> &Option<String>
pub fn get_screen_automation_id(&self) -> &Option<String>
The ID of the automation action to be performed.
Sourcepub fn variables(self, k: impl Into<String>, v: VariableValue) -> Self
pub fn variables(self, k: impl Into<String>, v: VariableValue) -> Self
Adds a key-value pair to variables
.
To override the contents of this collection use set_variables
.
Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen. Any variables defined in a screen are required to be passed in the call.
Sourcepub fn set_variables(
self,
input: Option<HashMap<String, VariableValue>>,
) -> Self
pub fn set_variables( self, input: Option<HashMap<String, VariableValue>>, ) -> Self
Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen. Any variables defined in a screen are required to be passed in the call.
Sourcepub fn get_variables(&self) -> &Option<HashMap<String, VariableValue>>
pub fn get_variables(&self) -> &Option<HashMap<String, VariableValue>>
Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen. Any variables defined in a screen are required to be passed in the call.
Sourcepub fn row_id(self, input: impl Into<String>) -> Self
pub fn row_id(self, input: impl Into<String>) -> Self
The row ID for the automation if the automation is defined inside a block with source or list.
Sourcepub fn set_row_id(self, input: Option<String>) -> Self
pub fn set_row_id(self, input: Option<String>) -> Self
The row ID for the automation if the automation is defined inside a block with source or list.
Sourcepub fn get_row_id(&self) -> &Option<String>
pub fn get_row_id(&self) -> &Option<String>
The row ID for the automation if the automation is defined inside a block with source or list.
Sourcepub fn client_request_token(self, input: impl Into<String>) -> Self
pub fn client_request_token(self, input: impl Into<String>) -> Self
The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again.
Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.
Sourcepub fn set_client_request_token(self, input: Option<String>) -> Self
pub fn set_client_request_token(self, input: Option<String>) -> Self
The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again.
Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.
Sourcepub fn get_client_request_token(&self) -> &Option<String>
pub fn get_client_request_token(&self) -> &Option<String>
The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again.
Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.
Trait Implementations§
Source§impl Clone for InvokeScreenAutomationFluentBuilder
impl Clone for InvokeScreenAutomationFluentBuilder
Source§fn clone(&self) -> InvokeScreenAutomationFluentBuilder
fn clone(&self) -> InvokeScreenAutomationFluentBuilder
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 InvokeScreenAutomationFluentBuilder
impl !RefUnwindSafe for InvokeScreenAutomationFluentBuilder
impl Send for InvokeScreenAutomationFluentBuilder
impl Sync for InvokeScreenAutomationFluentBuilder
impl Unpin for InvokeScreenAutomationFluentBuilder
impl !UnwindSafe for InvokeScreenAutomationFluentBuilder
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);