Class ListStatementsRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.redshiftdata.model.RedshiftDataRequest
-
- software.amazon.awssdk.services.redshiftdata.model.ListStatementsRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ListStatementsRequest.Builder,ListStatementsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListStatementsRequest extends RedshiftDataRequest implements ToCopyableBuilder<ListStatementsRequest.Builder,ListStatementsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceListStatementsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListStatementsRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()IntegermaxResults()The maximum number of SQL statements to return in the response.StringnextToken()A value that indicates the starting point for the next set of response records in a subsequent request.BooleanroleLevel()A value that filters which statements to return in the response.List<SdkField<?>>sdkFields()static Class<? extends ListStatementsRequest.Builder>serializableBuilderClass()StringstatementName()The name of the SQL statement specified as input toBatchExecuteStatementorExecuteStatementto identify the query.StatusStringstatus()The status of the SQL statement to list.StringstatusAsString()The status of the SQL statement to list.ListStatementsRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
maxResults
public final Integer maxResults()
The maximum number of SQL statements to return in the response. If more SQL statements exist than fit in one response, then
NextTokenis returned to page through the results.- Returns:
- The maximum number of SQL statements to return in the response. If more SQL statements exist than fit in
one response, then
NextTokenis returned to page through the results.
-
nextToken
public final 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.
- Returns:
- 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.
-
roleLevel
public final 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.
- Returns:
- 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.
-
statementName
public final String statementName()
The name of the SQL statement specified as input to
BatchExecuteStatementorExecuteStatementto 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 ofmyStatement. Data API does a case-sensitive match of SQL statement names to the prefix value you provide.- Returns:
- The name of the SQL statement specified as input to
BatchExecuteStatementorExecuteStatementto 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 ofmyStatement. Data API does a case-sensitive match of SQL statement names to the prefix value you provide.
-
status
public final 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.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnStatusString.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- 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.
-
- See Also:
StatusString
-
-
statusAsString
public final String statusAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnStatusString.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- 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.
-
- See Also:
StatusString
-
-
toBuilder
public ListStatementsRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ListStatementsRequest.Builder,ListStatementsRequest>- Specified by:
toBuilderin classRedshiftDataRequest
-
builder
public static ListStatementsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListStatementsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-