Package software.amazon.awssdk.services.honeycode.model

Interface GetScreenDataRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetScreenDataRequest.Builder,GetScreenDataRequest>, HoneycodeRequest.Builder, SdkBuilder<GetScreenDataRequest.Builder,GetScreenDataRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetScreenDataRequest
public static interface GetScreenDataRequest.Builder extends HoneycodeRequest.Builder, SdkPojo, CopyableBuilder<GetScreenDataRequest.Builder,GetScreenDataRequest>

  • Method Details

    • workbookId

      GetScreenDataRequest.Builder workbookId(String workbookId)

      The ID of the workbook that contains the screen.

      Parameters:
      workbookId - The ID of the workbook that contains the screen.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • appId

      GetScreenDataRequest.Builder appId(String appId)

      The ID of the app that contains the screen.

      Parameters:
      appId - The ID of the app that contains the screen.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • screenId

      GetScreenDataRequest.Builder screenId(String screenId)

      The ID of the screen.

      Parameters:
      screenId - The ID of the screen.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • variables

      GetScreenDataRequest.Builder variables(Map<String,VariableValue> 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      GetScreenDataRequest.Builder maxResults(Integer maxResults)

      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.

      Parameters:
      maxResults - 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:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      GetScreenDataRequest.Builder nextToken(String nextToken)

      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.

      Parameters:
      nextToken - 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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetScreenDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetScreenDataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.