Interface ExecuteStatementRequest.Builder

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

  • Method Details

    • clientToken

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

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

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

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

    • parameters

      ExecuteStatementRequest.Builder parameters(Collection<SqlParameter> parameters)

      The parameters for the SQL statement.

      Parameters:
      parameters - The parameters for the SQL statement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      ExecuteStatementRequest.Builder parameters(SqlParameter... parameters)

      The parameters for the SQL statement.

      Parameters:
      parameters - The parameters for the SQL statement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      ExecuteStatementRequest.Builder parameters(Consumer<SqlParameter.Builder>... parameters)

      The parameters for the SQL statement.

      This is a convenience method that creates an instance of the SqlParameter.Builder avoiding the need to create one manually via SqlParameter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to parameters(List<SqlParameter>).

      Parameters:
      parameters - a consumer that will call methods on SqlParameter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • secretArn

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

    • sessionId

      ExecuteStatementRequest.Builder sessionId(String sessionId)

      The session identifier of the query.

      Parameters:
      sessionId - The session identifier of the query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionKeepAliveSeconds

      ExecuteStatementRequest.Builder sessionKeepAliveSeconds(Integer sessionKeepAliveSeconds)

      The number of seconds to keep the session alive after the query finishes. The maximum time a session can keep alive is 24 hours. After 24 hours, the session is forced closed and the query is terminated.

      Parameters:
      sessionKeepAliveSeconds - The number of seconds to keep the session alive after the query finishes. The maximum time a session can keep alive is 24 hours. After 24 hours, the session is forced closed and the query is terminated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sql

      ExecuteStatementRequest.Builder sql(String sql)

      The SQL statement text to run.

      Parameters:
      sql - The SQL statement text to run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statementName

      ExecuteStatementRequest.Builder statementName(String statementName)

      The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

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

    • withEvent

      ExecuteStatementRequest.Builder withEvent(Boolean withEvent)

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

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

    • workgroupName

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

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

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