@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ListStatementsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
ListStatementsRequest() |
Modifier and Type | Method and Description |
---|---|
ListStatementsRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Integer |
getMaxResults()
The maximum number of SQL statements to return in the response.
|
String |
getNextToken()
A value that indicates the starting point for the next set of response records in a subsequent request.
|
Boolean |
getRoleLevel()
A value that filters which statements to return in the response.
|
String |
getStatementName()
The name of the SQL statement specified as input to
BatchExecuteStatement or
ExecuteStatement to identify the query. |
String |
getStatus()
The status of the SQL statement to list.
|
int |
hashCode() |
Boolean |
isRoleLevel()
A value that filters which statements to return in the response.
|
void |
setMaxResults(Integer maxResults)
The maximum number of SQL statements to return in the response.
|
void |
setNextToken(String nextToken)
A value that indicates the starting point for the next set of response records in a subsequent request.
|
void |
setRoleLevel(Boolean roleLevel)
A value that filters which statements to return in the response.
|
void |
setStatementName(String statementName)
The name of the SQL statement specified as input to
BatchExecuteStatement or
ExecuteStatement to identify the query. |
void |
setStatus(String status)
The status of the SQL statement to list.
|
String |
toString()
Returns a string representation of this object.
|
ListStatementsRequest |
withMaxResults(Integer maxResults)
The maximum number of SQL statements to return in the response.
|
ListStatementsRequest |
withNextToken(String nextToken)
A value that indicates the starting point for the next set of response records in a subsequent request.
|
ListStatementsRequest |
withRoleLevel(Boolean roleLevel)
A value that filters which statements to return in the response.
|
ListStatementsRequest |
withStatementName(String statementName)
The name of the SQL statement specified as input to
BatchExecuteStatement or
ExecuteStatement to identify the query. |
ListStatementsRequest |
withStatus(StatusString status)
The status of the SQL statement to list.
|
ListStatementsRequest |
withStatus(String status)
The status of the SQL statement to list.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setMaxResults(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.
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.public Integer getMaxResults()
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.
NextToken
is returned to page through the results.public ListStatementsRequest withMaxResults(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.
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.public void setNextToken(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.
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.public String getNextToken()
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.
public ListStatementsRequest withNextToken(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.
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.public void setRoleLevel(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.
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.public Boolean getRoleLevel()
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.
public ListStatementsRequest withRoleLevel(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.
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.public Boolean isRoleLevel()
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.
public void setStatementName(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.
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.public String getStatementName()
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.
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.public ListStatementsRequest withStatementName(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.
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.public void setStatus(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.
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.
StatusString
public String getStatus()
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.
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.
StatusString
public ListStatementsRequest withStatus(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.
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.
StatusString
public ListStatementsRequest withStatus(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.
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.
StatusString
public String toString()
toString
in class Object
Object.toString()
public ListStatementsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()