AWS SDK for C++  1.9.19
AWS SDK for C++
Public Member Functions | List of all members
Aws::RedshiftDataAPIService::Model::ListStatementsRequest Class Reference

#include <ListStatementsRequest.h>

+ Inheritance diagram for Aws::RedshiftDataAPIService::Model::ListStatementsRequest:

Public Member Functions

 ListStatementsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListStatementsRequestWithMaxResults (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListStatementsRequestWithNextToken (const Aws::String &value)
 
ListStatementsRequestWithNextToken (Aws::String &&value)
 
ListStatementsRequestWithNextToken (const char *value)
 
bool GetRoleLevel () const
 
bool RoleLevelHasBeenSet () const
 
void SetRoleLevel (bool value)
 
ListStatementsRequestWithRoleLevel (bool value)
 
const Aws::StringGetStatementName () const
 
bool StatementNameHasBeenSet () const
 
void SetStatementName (const Aws::String &value)
 
void SetStatementName (Aws::String &&value)
 
void SetStatementName (const char *value)
 
ListStatementsRequestWithStatementName (const Aws::String &value)
 
ListStatementsRequestWithStatementName (Aws::String &&value)
 
ListStatementsRequestWithStatementName (const char *value)
 
const StatusStringGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const StatusString &value)
 
void SetStatus (StatusString &&value)
 
ListStatementsRequestWithStatus (const StatusString &value)
 
ListStatementsRequestWithStatus (StatusString &&value)
 
- Public Member Functions inherited from Aws::RedshiftDataAPIService::RedshiftDataAPIServiceRequest
virtual ~RedshiftDataAPIServiceRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file ListStatementsRequest.h.

Constructor & Destructor Documentation

◆ ListStatementsRequest()

Aws::RedshiftDataAPIService::Model::ListStatementsRequest::ListStatementsRequest ( )

Member Function Documentation

◆ GetMaxResults()

int Aws::RedshiftDataAPIService::Model::ListStatementsRequest::GetMaxResults ( ) const
inline

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.

Definition at line 43 of file ListStatementsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::RedshiftDataAPIService::Model::ListStatementsRequest::GetNextToken ( ) const
inline

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.

Definition at line 74 of file ListStatementsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::RedshiftDataAPIService::Model::ListStatementsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetRoleLevel()

bool Aws::RedshiftDataAPIService::Model::ListStatementsRequest::GetRoleLevel ( ) const
inline

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.

Definition at line 146 of file ListStatementsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::RedshiftDataAPIService::Model::ListStatementsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file ListStatementsRequest.h.

◆ GetStatementName()

const Aws::String& Aws::RedshiftDataAPIService::Model::ListStatementsRequest::GetStatementName ( ) const
inline

The name of the SQL statement specified as input to 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.

Definition at line 182 of file ListStatementsRequest.h.

◆ GetStatus()

const StatusString& Aws::RedshiftDataAPIService::Model::ListStatementsRequest::GetStatus ( ) const
inline

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.

Definition at line 272 of file ListStatementsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ListStatementsRequest::MaxResultsHasBeenSet ( ) const
inline

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.

Definition at line 50 of file ListStatementsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ListStatementsRequest::NextTokenHasBeenSet ( ) const
inline

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.

Definition at line 83 of file ListStatementsRequest.h.

◆ RoleLevelHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ListStatementsRequest::RoleLevelHasBeenSet ( ) const
inline

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.

Definition at line 154 of file ListStatementsRequest.h.

◆ SerializePayload()

Aws::String Aws::RedshiftDataAPIService::Model::ListStatementsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetMaxResults()

void Aws::RedshiftDataAPIService::Model::ListStatementsRequest::SetMaxResults ( int  value)
inline

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.

Definition at line 57 of file ListStatementsRequest.h.

◆ SetNextToken() [1/3]

void Aws::RedshiftDataAPIService::Model::ListStatementsRequest::SetNextToken ( Aws::String &&  value)
inline

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.

Definition at line 101 of file ListStatementsRequest.h.

◆ SetNextToken() [2/3]

void Aws::RedshiftDataAPIService::Model::ListStatementsRequest::SetNextToken ( const Aws::String value)
inline

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.

Definition at line 92 of file ListStatementsRequest.h.

◆ SetNextToken() [3/3]

void Aws::RedshiftDataAPIService::Model::ListStatementsRequest::SetNextToken ( const char *  value)
inline

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.

Definition at line 110 of file ListStatementsRequest.h.

◆ SetRoleLevel()

void Aws::RedshiftDataAPIService::Model::ListStatementsRequest::SetRoleLevel ( bool  value)
inline

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.

Definition at line 162 of file ListStatementsRequest.h.

◆ SetStatementName() [1/3]

void Aws::RedshiftDataAPIService::Model::ListStatementsRequest::SetStatementName ( Aws::String &&  value)
inline

The name of the SQL statement specified as input to 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.

Definition at line 215 of file ListStatementsRequest.h.

◆ SetStatementName() [2/3]

void Aws::RedshiftDataAPIService::Model::ListStatementsRequest::SetStatementName ( const Aws::String value)
inline

The name of the SQL statement specified as input to 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.

Definition at line 204 of file ListStatementsRequest.h.

◆ SetStatementName() [3/3]

void Aws::RedshiftDataAPIService::Model::ListStatementsRequest::SetStatementName ( const char *  value)
inline

The name of the SQL statement specified as input to 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.

Definition at line 226 of file ListStatementsRequest.h.

◆ SetStatus() [1/2]

void Aws::RedshiftDataAPIService::Model::ListStatementsRequest::SetStatus ( const StatusString value)
inline

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.

Definition at line 296 of file ListStatementsRequest.h.

◆ SetStatus() [2/2]

void Aws::RedshiftDataAPIService::Model::ListStatementsRequest::SetStatus ( StatusString &&  value)
inline

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.

Definition at line 308 of file ListStatementsRequest.h.

◆ StatementNameHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ListStatementsRequest::StatementNameHasBeenSet ( ) const
inline

The name of the SQL statement specified as input to 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.

Definition at line 193 of file ListStatementsRequest.h.

◆ StatusHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ListStatementsRequest::StatusHasBeenSet ( ) const
inline

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.

Definition at line 284 of file ListStatementsRequest.h.

◆ WithMaxResults()

ListStatementsRequest& Aws::RedshiftDataAPIService::Model::ListStatementsRequest::WithMaxResults ( int  value)
inline

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.

Definition at line 64 of file ListStatementsRequest.h.

◆ WithNextToken() [1/3]

ListStatementsRequest& Aws::RedshiftDataAPIService::Model::ListStatementsRequest::WithNextToken ( Aws::String &&  value)
inline

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.

Definition at line 128 of file ListStatementsRequest.h.

◆ WithNextToken() [2/3]

ListStatementsRequest& Aws::RedshiftDataAPIService::Model::ListStatementsRequest::WithNextToken ( const Aws::String value)
inline

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.

Definition at line 119 of file ListStatementsRequest.h.

◆ WithNextToken() [3/3]

ListStatementsRequest& Aws::RedshiftDataAPIService::Model::ListStatementsRequest::WithNextToken ( const char *  value)
inline

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.

Definition at line 137 of file ListStatementsRequest.h.

◆ WithRoleLevel()

ListStatementsRequest& Aws::RedshiftDataAPIService::Model::ListStatementsRequest::WithRoleLevel ( bool  value)
inline

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.

Definition at line 170 of file ListStatementsRequest.h.

◆ WithStatementName() [1/3]

ListStatementsRequest& Aws::RedshiftDataAPIService::Model::ListStatementsRequest::WithStatementName ( Aws::String &&  value)
inline

The name of the SQL statement specified as input to 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.

Definition at line 248 of file ListStatementsRequest.h.

◆ WithStatementName() [2/3]

ListStatementsRequest& Aws::RedshiftDataAPIService::Model::ListStatementsRequest::WithStatementName ( const Aws::String value)
inline

The name of the SQL statement specified as input to 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.

Definition at line 237 of file ListStatementsRequest.h.

◆ WithStatementName() [3/3]

ListStatementsRequest& Aws::RedshiftDataAPIService::Model::ListStatementsRequest::WithStatementName ( const char *  value)
inline

The name of the SQL statement specified as input to 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.

Definition at line 259 of file ListStatementsRequest.h.

◆ WithStatus() [1/2]

ListStatementsRequest& Aws::RedshiftDataAPIService::Model::ListStatementsRequest::WithStatus ( const StatusString value)
inline

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.

Definition at line 320 of file ListStatementsRequest.h.

◆ WithStatus() [2/2]

ListStatementsRequest& Aws::RedshiftDataAPIService::Model::ListStatementsRequest::WithStatus ( StatusString &&  value)
inline

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.

Definition at line 332 of file ListStatementsRequest.h.


The documentation for this class was generated from the following file: