Package software.amazon.awssdk.services.redshiftdata.model

Interface BatchExecuteStatementRequest.Builder

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

  • Method Details

    • clientToken

      BatchExecuteStatementRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

      Parameters:
      clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterIdentifier

      BatchExecuteStatementRequest.Builder clusterIdentifier(String clusterIdentifier)

      The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

      Parameters:
      clusterIdentifier - The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • database

      BatchExecuteStatementRequest.Builder database(String database)

      The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

      Parameters:
      database - The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dbUser

      BatchExecuteStatementRequest.Builder dbUser(String dbUser)

      The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.

      Parameters:
      dbUser - The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secretArn

      BatchExecuteStatementRequest.Builder secretArn(String secretArn)

      The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

      Parameters:
      secretArn - The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sqls

      BatchExecuteStatementRequest.Builder sqls(Collection<String> sqls)

      One or more SQL statements to run. 

        The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.</p>
      Parameters:
      sqls - One or more SQL statements to run. 
       
         The SQL statements are run as a single transaction. They run serially in the order of the
        array. Subsequent SQL statements don't start until the previous statement in the array completes. If
        any SQL statement fails, then because they are run as one transaction, all work is rolled
        back.</p>  @return Returns a reference to this object so that method calls can be chained
        together.

    • sqls

      BatchExecuteStatementRequest.Builder sqls(String... sqls)

      One or more SQL statements to run. 

        The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.</p>
      Parameters:
      sqls - One or more SQL statements to run. 
       
         The SQL statements are run as a single transaction. They run serially in the order of the
        array. Subsequent SQL statements don't start until the previous statement in the array completes. If
        any SQL statement fails, then because they are run as one transaction, all work is rolled
        back.</p>  @return Returns a reference to this object so that method calls can be chained
        together.

    • statementName

      BatchExecuteStatementRequest.Builder statementName(String statementName)

      The name of the SQL statements. You can name the SQL statements when you create them to identify the query.

      Parameters:
      statementName - The name of the SQL statements. You can name the SQL statements when you create them to identify the query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • withEvent

      BatchExecuteStatementRequest.Builder withEvent(Boolean withEvent)

      A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.

      Parameters:
      withEvent - A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workgroupName

      BatchExecuteStatementRequest.Builder workgroupName(String workgroupName)

      The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

      Parameters:
      workgroupName - The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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