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

Interface ListStatementsRequest.Builder

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

  • Method Details

    • maxResults

      ListStatementsRequest.Builder maxResults(Integer maxResults)

      The maximum number of SQL statements to return in the response. If more SQL statements exist than fit in one response, then NextToken is returned to page through the results.

      Parameters:
      maxResults - The maximum number of SQL statements to return in the response. If more SQL statements exist than fit in one response, then NextToken is returned to page through the results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListStatementsRequest.Builder nextToken(String nextToken)

      A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

      Parameters:
      nextToken - A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleLevel

      ListStatementsRequest.Builder roleLevel(Boolean roleLevel)

      A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned. If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true.

      Parameters:
      roleLevel - A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned. If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statementName

      ListStatementsRequest.Builder statementName(String statementName)

      The name of the SQL statement specified as input to BatchExecuteStatement or ExecuteStatement to identify the query. You can list multiple statements by providing a prefix that matches the beginning of the statement name. For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of myStatement. Data API does a case-sensitive match of SQL statement names to the prefix value you provide.

      Parameters:
      statementName - The name of the SQL statement specified as input to BatchExecuteStatement or ExecuteStatement to identify the query. You can list multiple statements by providing a prefix that matches the beginning of the statement name. For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of myStatement. Data API does a case-sensitive match of SQL statement names to the prefix value you provide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      ListStatementsRequest.Builder status(String status)

      The status of the SQL statement to list. Status values are defined as follows:

      • ABORTED - The query run was stopped by the user.

      • ALL - A status value that includes all query statuses. This value can be used to filter results.

      • FAILED - The query run failed.

      • FINISHED - The query has finished running.

      • PICKED - The query has been chosen to be run.

      • STARTED - The query run has started.

      • SUBMITTED - The query was submitted, but not yet processed.

      Parameters:
      status - The status of the SQL statement to list. Status values are defined as follows:

      • ABORTED - The query run was stopped by the user.

      • ALL - A status value that includes all query statuses. This value can be used to filter results.

      • FAILED - The query run failed.

      • FINISHED - The query has finished running.

      • PICKED - The query has been chosen to be run.

      • STARTED - The query run has started.

      • SUBMITTED - The query was submitted, but not yet processed.

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

    • status

      ListStatementsRequest.Builder status(StatusString status)

      The status of the SQL statement to list. Status values are defined as follows:

      • ABORTED - The query run was stopped by the user.

      • ALL - A status value that includes all query statuses. This value can be used to filter results.

      • FAILED - The query run failed.

      • FINISHED - The query has finished running.

      • PICKED - The query has been chosen to be run.

      • STARTED - The query run has started.

      • SUBMITTED - The query was submitted, but not yet processed.

      Parameters:
      status - The status of the SQL statement to list. Status values are defined as follows:

      • ABORTED - The query run was stopped by the user.

      • ALL - A status value that includes all query statuses. This value can be used to filter results.

      • FAILED - The query run failed.

      • FINISHED - The query has finished running.

      • PICKED - The query has been chosen to be run.

      • STARTED - The query run has started.

      • SUBMITTED - The query was submitted, but not yet processed.

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

    • overrideConfiguration

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

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