pub struct GetScreenDataFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to GetScreenData
.
The GetScreenData API allows retrieval of data from a screen in a Honeycode app. The API allows setting local variables in the screen to filter, sort or otherwise affect what will be displayed on the screen.
Implementations§
source§impl GetScreenDataFluentBuilder
impl GetScreenDataFluentBuilder
sourcepub fn as_input(&self) -> &GetScreenDataInputBuilder
pub fn as_input(&self) -> &GetScreenDataInputBuilder
Access the GetScreenData as a reference.
sourcepub async fn send(
self
) -> Result<GetScreenDataOutput, SdkError<GetScreenDataError, HttpResponse>>
pub async fn send( self ) -> Result<GetScreenDataOutput, SdkError<GetScreenDataError, 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<GetScreenDataOutput, GetScreenDataError, Self>
pub fn customize( self ) -> CustomizableOperation<GetScreenDataOutput, GetScreenDataError, 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.
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.
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.
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.
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.
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.
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.
sourcepub fn get_screen_id(&self) -> &Option<String>
pub fn get_screen_id(&self) -> &Option<String>
The ID of the screen.
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 optional and are needed only if the screen requires them to render correctly. 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.
sourcepub fn set_variables(
self,
input: Option<HashMap<String, VariableValue>>
) -> Self
pub fn set_variables( self, input: Option<HashMap<String, VariableValue>> ) -> Self
Variables are optional and are needed only if the screen requires them to render correctly. 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.
sourcepub fn get_variables(&self) -> &Option<HashMap<String, VariableValue>>
pub fn get_variables(&self) -> &Option<HashMap<String, VariableValue>>
Variables are optional and are needed only if the screen requires them to render correctly. 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.
sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
The number of results to be returned on a single page. Specify a number between 1 and 100. The maximum value is 100.
This parameter is optional. If you don't specify this parameter, the default page size is 100.
sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
The number of results to be returned on a single page. Specify a number between 1 and 100. The maximum value is 100.
This parameter is optional. If you don't specify this parameter, the default page size is 100.
sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
The number of results to be returned on a single page. Specify a number between 1 and 100. The maximum value is 100.
This parameter is optional. If you don't specify this parameter, the default page size is 100.
sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
This parameter is optional. If a nextToken is not specified, the API returns the first page of data.
Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
This parameter is optional. If a nextToken is not specified, the API returns the first page of data.
Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
This parameter is optional. If a nextToken is not specified, the API returns the first page of data.
Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.
Trait Implementations§
source§impl Clone for GetScreenDataFluentBuilder
impl Clone for GetScreenDataFluentBuilder
source§fn clone(&self) -> GetScreenDataFluentBuilder
fn clone(&self) -> GetScreenDataFluentBuilder
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 GetScreenDataFluentBuilder
impl !RefUnwindSafe for GetScreenDataFluentBuilder
impl Send for GetScreenDataFluentBuilder
impl Sync for GetScreenDataFluentBuilder
impl Unpin for GetScreenDataFluentBuilder
impl !UnwindSafe for GetScreenDataFluentBuilder
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> 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 more