Class: Aws::Honeycode::Types::GetScreenDataRequest

Inherits:

Struct

• Object
• Struct
• Aws::Honeycode::Types::GetScreenDataRequest

Includes:

Structure

Defined in:

lib/aws-sdk-honeycode/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:variables]

Instance Attribute Summary

• #app_id ⇒ String

  The ID of the app that contains the screen.

• #max_results ⇒ Integer

  The number of results to be returned on a single page.

• #next_token ⇒ String

  This parameter is optional.

• #screen_id ⇒ String

  The ID of the screen.

• #variables ⇒ Hash<String,Types::VariableValue>

  Variables are optional and are needed only if the screen requires them to render correctly.

• #workbook_id ⇒ String

  The ID of the workbook that contains the screen.

Instance Attribute Details

#app_id ⇒ String

The ID of the app that contains the screen.

Returns:

• (String)

# File 'lib/aws-sdk-honeycode/types.rb', line 757

class GetScreenDataRequest < Struct.new(
  :workbook_id,
  :app_id,
  :screen_id,
  :variables,
  :max_results,
  :next_token)
  SENSITIVE = [:variables]
  include Aws::Structure
end

#max_results ⇒ Integer

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.

Returns:

• (Integer)

# File 'lib/aws-sdk-honeycode/types.rb', line 757

class GetScreenDataRequest < Struct.new(
  :workbook_id,
  :app_id,
  :screen_id,
  :variables,
  :max_results,
  :next_token)
  SENSITIVE = [:variables]
  include Aws::Structure
end

#next_token ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-honeycode/types.rb', line 757

class GetScreenDataRequest < Struct.new(
  :workbook_id,
  :app_id,
  :screen_id,
  :variables,
  :max_results,
  :next_token)
  SENSITIVE = [:variables]
  include Aws::Structure
end

#screen_id ⇒ String

The ID of the screen.

Returns:

• (String)

# File 'lib/aws-sdk-honeycode/types.rb', line 757

class GetScreenDataRequest < Struct.new(
  :workbook_id,
  :app_id,
  :screen_id,
  :variables,
  :max_results,
  :next_token)
  SENSITIVE = [:variables]
  include Aws::Structure
end

#variables ⇒ Hash<String,Types::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.

Returns:

• (Hash<String,Types::VariableValue>)

# File 'lib/aws-sdk-honeycode/types.rb', line 757

class GetScreenDataRequest < Struct.new(
  :workbook_id,
  :app_id,
  :screen_id,
  :variables,
  :max_results,
  :next_token)
  SENSITIVE = [:variables]
  include Aws::Structure
end

#workbook_id ⇒ String

The ID of the workbook that contains the screen.

Returns:

• (String)

# File 'lib/aws-sdk-honeycode/types.rb', line 757

class GetScreenDataRequest < Struct.new(
  :workbook_id,
  :app_id,
  :screen_id,
  :variables,
  :max_results,
  :next_token)
  SENSITIVE = [:variables]
  include Aws::Structure
end