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

#include <ExecuteStatementRequest.h>

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

Public Member Functions

 ExecuteStatementRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetClusterIdentifier () const
 
bool ClusterIdentifierHasBeenSet () const
 
void SetClusterIdentifier (const Aws::String &value)
 
void SetClusterIdentifier (Aws::String &&value)
 
void SetClusterIdentifier (const char *value)
 
ExecuteStatementRequestWithClusterIdentifier (const Aws::String &value)
 
ExecuteStatementRequestWithClusterIdentifier (Aws::String &&value)
 
ExecuteStatementRequestWithClusterIdentifier (const char *value)
 
const Aws::StringGetDatabase () const
 
bool DatabaseHasBeenSet () const
 
void SetDatabase (const Aws::String &value)
 
void SetDatabase (Aws::String &&value)
 
void SetDatabase (const char *value)
 
ExecuteStatementRequestWithDatabase (const Aws::String &value)
 
ExecuteStatementRequestWithDatabase (Aws::String &&value)
 
ExecuteStatementRequestWithDatabase (const char *value)
 
const Aws::StringGetDbUser () const
 
bool DbUserHasBeenSet () const
 
void SetDbUser (const Aws::String &value)
 
void SetDbUser (Aws::String &&value)
 
void SetDbUser (const char *value)
 
ExecuteStatementRequestWithDbUser (const Aws::String &value)
 
ExecuteStatementRequestWithDbUser (Aws::String &&value)
 
ExecuteStatementRequestWithDbUser (const char *value)
 
const Aws::StringGetSecretArn () const
 
bool SecretArnHasBeenSet () const
 
void SetSecretArn (const Aws::String &value)
 
void SetSecretArn (Aws::String &&value)
 
void SetSecretArn (const char *value)
 
ExecuteStatementRequestWithSecretArn (const Aws::String &value)
 
ExecuteStatementRequestWithSecretArn (Aws::String &&value)
 
ExecuteStatementRequestWithSecretArn (const char *value)
 
const Aws::StringGetSql () const
 
bool SqlHasBeenSet () const
 
void SetSql (const Aws::String &value)
 
void SetSql (Aws::String &&value)
 
void SetSql (const char *value)
 
ExecuteStatementRequestWithSql (const Aws::String &value)
 
ExecuteStatementRequestWithSql (Aws::String &&value)
 
ExecuteStatementRequestWithSql (const char *value)
 
const Aws::StringGetStatementName () const
 
bool StatementNameHasBeenSet () const
 
void SetStatementName (const Aws::String &value)
 
void SetStatementName (Aws::String &&value)
 
void SetStatementName (const char *value)
 
ExecuteStatementRequestWithStatementName (const Aws::String &value)
 
ExecuteStatementRequestWithStatementName (Aws::String &&value)
 
ExecuteStatementRequestWithStatementName (const char *value)
 
bool GetWithEvent () const
 
bool WithEventHasBeenSet () const
 
void SetWithEvent (bool value)
 
ExecuteStatementRequestWithWithEvent (bool 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 21 of file ExecuteStatementRequest.h.

Constructor & Destructor Documentation

◆ ExecuteStatementRequest()

Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::ExecuteStatementRequest ( )

Member Function Documentation

◆ ClusterIdentifierHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::ClusterIdentifierHasBeenSet ( ) const
inline

The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

Definition at line 47 of file ExecuteStatementRequest.h.

◆ DatabaseHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::DatabaseHasBeenSet ( ) const
inline

The name of the database. This parameter is required when authenticating using temporary credentials.

Definition at line 96 of file ExecuteStatementRequest.h.

◆ DbUserHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::DbUserHasBeenSet ( ) const
inline

The database user name. This parameter is required when authenticating using temporary credentials.

Definition at line 145 of file ExecuteStatementRequest.h.

◆ GetClusterIdentifier()

const Aws::String& Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::GetClusterIdentifier ( ) const
inline

The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

Definition at line 41 of file ExecuteStatementRequest.h.

◆ GetDatabase()

const Aws::String& Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::GetDatabase ( ) const
inline

The name of the database. This parameter is required when authenticating using temporary credentials.

Definition at line 90 of file ExecuteStatementRequest.h.

◆ GetDbUser()

const Aws::String& Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::GetDbUser ( ) const
inline

The database user name. This parameter is required when authenticating using temporary credentials.

Definition at line 139 of file ExecuteStatementRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetSecretArn()

const Aws::String& Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::GetSecretArn ( ) const
inline

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

Definition at line 188 of file ExecuteStatementRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file ExecuteStatementRequest.h.

◆ GetSql()

const Aws::String& Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::GetSql ( ) const
inline

The SQL statement text to run.

Definition at line 236 of file ExecuteStatementRequest.h.

◆ GetStatementName()

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

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

Definition at line 278 of file ExecuteStatementRequest.h.

◆ GetWithEvent()

bool Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::GetWithEvent ( ) const
inline

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

Definition at line 327 of file ExecuteStatementRequest.h.

◆ SecretArnHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::SecretArnHasBeenSet ( ) const
inline

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

Definition at line 194 of file ExecuteStatementRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClusterIdentifier() [1/3]

void Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::SetClusterIdentifier ( Aws::String &&  value)
inline

The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

Definition at line 59 of file ExecuteStatementRequest.h.

◆ SetClusterIdentifier() [2/3]

void Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::SetClusterIdentifier ( const Aws::String value)
inline

The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

Definition at line 53 of file ExecuteStatementRequest.h.

◆ SetClusterIdentifier() [3/3]

void Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::SetClusterIdentifier ( const char *  value)
inline

The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

Definition at line 65 of file ExecuteStatementRequest.h.

◆ SetDatabase() [1/3]

void Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::SetDatabase ( Aws::String &&  value)
inline

The name of the database. This parameter is required when authenticating using temporary credentials.

Definition at line 108 of file ExecuteStatementRequest.h.

◆ SetDatabase() [2/3]

void Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::SetDatabase ( const Aws::String value)
inline

The name of the database. This parameter is required when authenticating using temporary credentials.

Definition at line 102 of file ExecuteStatementRequest.h.

◆ SetDatabase() [3/3]

void Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::SetDatabase ( const char *  value)
inline

The name of the database. This parameter is required when authenticating using temporary credentials.

Definition at line 114 of file ExecuteStatementRequest.h.

◆ SetDbUser() [1/3]

void Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::SetDbUser ( Aws::String &&  value)
inline

The database user name. This parameter is required when authenticating using temporary credentials.

Definition at line 157 of file ExecuteStatementRequest.h.

◆ SetDbUser() [2/3]

void Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::SetDbUser ( const Aws::String value)
inline

The database user name. This parameter is required when authenticating using temporary credentials.

Definition at line 151 of file ExecuteStatementRequest.h.

◆ SetDbUser() [3/3]

void Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::SetDbUser ( const char *  value)
inline

The database user name. This parameter is required when authenticating using temporary credentials.

Definition at line 163 of file ExecuteStatementRequest.h.

◆ SetSecretArn() [1/3]

void Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::SetSecretArn ( Aws::String &&  value)
inline

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

Definition at line 206 of file ExecuteStatementRequest.h.

◆ SetSecretArn() [2/3]

void Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::SetSecretArn ( const Aws::String value)
inline

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

Definition at line 200 of file ExecuteStatementRequest.h.

◆ SetSecretArn() [3/3]

void Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::SetSecretArn ( const char *  value)
inline

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

Definition at line 212 of file ExecuteStatementRequest.h.

◆ SetSql() [1/3]

void Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::SetSql ( Aws::String &&  value)
inline

The SQL statement text to run.

Definition at line 251 of file ExecuteStatementRequest.h.

◆ SetSql() [2/3]

void Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::SetSql ( const Aws::String value)
inline

The SQL statement text to run.

Definition at line 246 of file ExecuteStatementRequest.h.

◆ SetSql() [3/3]

void Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::SetSql ( const char *  value)
inline

The SQL statement text to run.

Definition at line 256 of file ExecuteStatementRequest.h.

◆ SetStatementName() [1/3]

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

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

Definition at line 296 of file ExecuteStatementRequest.h.

◆ SetStatementName() [2/3]

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

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

Definition at line 290 of file ExecuteStatementRequest.h.

◆ SetStatementName() [3/3]

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

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

Definition at line 302 of file ExecuteStatementRequest.h.

◆ SetWithEvent()

void Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::SetWithEvent ( bool  value)
inline

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

Definition at line 339 of file ExecuteStatementRequest.h.

◆ SqlHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::SqlHasBeenSet ( ) const
inline

The SQL statement text to run.

Definition at line 241 of file ExecuteStatementRequest.h.

◆ StatementNameHasBeenSet()

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

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

Definition at line 284 of file ExecuteStatementRequest.h.

◆ WithClusterIdentifier() [1/3]

ExecuteStatementRequest& Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::WithClusterIdentifier ( Aws::String &&  value)
inline

The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

Definition at line 77 of file ExecuteStatementRequest.h.

◆ WithClusterIdentifier() [2/3]

ExecuteStatementRequest& Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::WithClusterIdentifier ( const Aws::String value)
inline

The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

Definition at line 71 of file ExecuteStatementRequest.h.

◆ WithClusterIdentifier() [3/3]

ExecuteStatementRequest& Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::WithClusterIdentifier ( const char *  value)
inline

The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials.

Definition at line 83 of file ExecuteStatementRequest.h.

◆ WithDatabase() [1/3]

ExecuteStatementRequest& Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::WithDatabase ( Aws::String &&  value)
inline

The name of the database. This parameter is required when authenticating using temporary credentials.

Definition at line 126 of file ExecuteStatementRequest.h.

◆ WithDatabase() [2/3]

ExecuteStatementRequest& Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::WithDatabase ( const Aws::String value)
inline

The name of the database. This parameter is required when authenticating using temporary credentials.

Definition at line 120 of file ExecuteStatementRequest.h.

◆ WithDatabase() [3/3]

ExecuteStatementRequest& Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::WithDatabase ( const char *  value)
inline

The name of the database. This parameter is required when authenticating using temporary credentials.

Definition at line 132 of file ExecuteStatementRequest.h.

◆ WithDbUser() [1/3]

ExecuteStatementRequest& Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::WithDbUser ( Aws::String &&  value)
inline

The database user name. This parameter is required when authenticating using temporary credentials.

Definition at line 175 of file ExecuteStatementRequest.h.

◆ WithDbUser() [2/3]

ExecuteStatementRequest& Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::WithDbUser ( const Aws::String value)
inline

The database user name. This parameter is required when authenticating using temporary credentials.

Definition at line 169 of file ExecuteStatementRequest.h.

◆ WithDbUser() [3/3]

ExecuteStatementRequest& Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::WithDbUser ( const char *  value)
inline

The database user name. This parameter is required when authenticating using temporary credentials.

Definition at line 181 of file ExecuteStatementRequest.h.

◆ WithEventHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::WithEventHasBeenSet ( ) const
inline

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

Definition at line 333 of file ExecuteStatementRequest.h.

◆ WithSecretArn() [1/3]

ExecuteStatementRequest& Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::WithSecretArn ( Aws::String &&  value)
inline

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

Definition at line 224 of file ExecuteStatementRequest.h.

◆ WithSecretArn() [2/3]

ExecuteStatementRequest& Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::WithSecretArn ( const Aws::String value)
inline

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

Definition at line 218 of file ExecuteStatementRequest.h.

◆ WithSecretArn() [3/3]

ExecuteStatementRequest& Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::WithSecretArn ( const char *  value)
inline

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using AWS Secrets Manager.

Definition at line 230 of file ExecuteStatementRequest.h.

◆ WithSql() [1/3]

ExecuteStatementRequest& Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::WithSql ( Aws::String &&  value)
inline

The SQL statement text to run.

Definition at line 266 of file ExecuteStatementRequest.h.

◆ WithSql() [2/3]

ExecuteStatementRequest& Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::WithSql ( const Aws::String value)
inline

The SQL statement text to run.

Definition at line 261 of file ExecuteStatementRequest.h.

◆ WithSql() [3/3]

ExecuteStatementRequest& Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::WithSql ( const char *  value)
inline

The SQL statement text to run.

Definition at line 271 of file ExecuteStatementRequest.h.

◆ WithStatementName() [1/3]

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

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

Definition at line 314 of file ExecuteStatementRequest.h.

◆ WithStatementName() [2/3]

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

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

Definition at line 308 of file ExecuteStatementRequest.h.

◆ WithStatementName() [3/3]

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

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

Definition at line 320 of file ExecuteStatementRequest.h.

◆ WithWithEvent()

ExecuteStatementRequest& Aws::RedshiftDataAPIService::Model::ExecuteStatementRequest::WithWithEvent ( bool  value)
inline

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

Definition at line 345 of file ExecuteStatementRequest.h.


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