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

Interface InvokeScreenAutomationRequest.Builder

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

  • Method Details

    • workbookId

      InvokeScreenAutomationRequest.Builder workbookId(String workbookId)

      The ID of the workbook that contains the screen automation.

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

    • appId

      InvokeScreenAutomationRequest.Builder appId(String appId)

      The ID of the app that contains the screen automation.

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

    • screenId

      InvokeScreenAutomationRequest.Builder screenId(String screenId)

      The ID of the screen that contains the screen automation.

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

    • screenAutomationId

      InvokeScreenAutomationRequest.Builder screenAutomationId(String screenAutomationId)

      The ID of the automation action to be performed.

      Parameters:
      screenAutomationId - The ID of the automation action to be performed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • variables

      InvokeScreenAutomationRequest.Builder variables(Map<String,VariableValue> variables)

      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. Any variables defined in a screen are required to be passed in the call.

      Parameters:
      variables - 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. Any variables defined in a screen are required to be passed in the call.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rowId

      InvokeScreenAutomationRequest.Builder rowId(String rowId)

      The row ID for the automation if the automation is defined inside a block with source or list.

      Parameters:
      rowId - The row ID for the automation if the automation is defined inside a block with source or list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientRequestToken

      InvokeScreenAutomationRequest.Builder clientRequestToken(String clientRequestToken)

      The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again.

      Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

      Parameters:
      clientRequestToken - The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again.

      Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      InvokeScreenAutomationRequest.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

      InvokeScreenAutomationRequest.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.