Struct GetScreenDataFluentBuilder

pub struct GetScreenDataFluentBuilder { /* private fields */ }

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

impl GetScreenDataFluentBuilder

pub fn as_input(&self) -> &GetScreenDataInputBuilder

Access the GetScreenData as a reference.

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.

pub fn customize( self, ) -> CustomizableOperation<GetScreenDataOutput, GetScreenDataError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn workbook_id(self, input: impl Into<String>) -> Self

The ID of the workbook that contains the screen.

pub fn set_workbook_id(self, input: Option<String>) -> Self

The ID of the workbook that contains the screen.

pub fn get_workbook_id(&self) -> &Option<String>

The ID of the workbook that contains the screen.

pub fn app_id(self, input: impl Into<String>) -> Self

The ID of the app that contains the screen.

pub fn set_app_id(self, input: Option<String>) -> Self

The ID of the app that contains the screen.

pub fn get_app_id(&self) -> &Option<String>

The ID of the app that contains the screen.

pub fn screen_id(self, input: impl Into<String>) -> Self

The ID of the screen.

pub fn set_screen_id(self, input: Option<String>) -> Self

The ID of the screen.

pub fn get_screen_id(&self) -> &Option<String>

The ID of the screen.

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.

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.

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.

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.

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.

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.

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.

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.

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

impl Clone for GetScreenDataFluentBuilder

fn clone(&self) -> GetScreenDataFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetScreenDataFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.