Struct GetScreenDataInput

#[non_exhaustive]
pub struct GetScreenDataInput {
    pub workbook_id: Option<String>,
    pub app_id: Option<String>,
    pub screen_id: Option<String>,
    pub variables: Option<HashMap<String, VariableValue>>,
    pub max_results: Option<i32>,
    pub next_token: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

workbook_id: Option<String>

The ID of the workbook that contains the screen.

app_id: Option<String>

The ID of the app that contains the screen.

screen_id: Option<String>

The ID of the screen.

variables: 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.

max_results: 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.

next_token: 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.

Implementations

impl GetScreenDataInput

pub fn workbook_id(&self) -> Option<&str>

The ID of the workbook that contains the screen.

pub fn app_id(&self) -> Option<&str>

The ID of the app that contains the screen.

pub fn screen_id(&self) -> Option<&str>

The ID of the screen.

pub fn 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) -> 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) -> Option<&str>

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.

impl GetScreenDataInput

pub fn builder() -> GetScreenDataInputBuilder

Creates a new builder-style object to manufacture GetScreenDataInput.

Trait Implementations

impl Clone for GetScreenDataInput

fn clone(&self) -> GetScreenDataInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetScreenDataInput

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

Formats the value using the given formatter.

impl PartialEq for GetScreenDataInput

fn eq(&self, other: &GetScreenDataInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetScreenDataInput