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

#include <ListDatabasesRequest.h>

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

Public Member Functions

 ListDatabasesRequest ()
 
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)
 
ListDatabasesRequestWithClusterIdentifier (const Aws::String &value)
 
ListDatabasesRequestWithClusterIdentifier (Aws::String &&value)
 
ListDatabasesRequestWithClusterIdentifier (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)
 
ListDatabasesRequestWithDatabase (const Aws::String &value)
 
ListDatabasesRequestWithDatabase (Aws::String &&value)
 
ListDatabasesRequestWithDatabase (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)
 
ListDatabasesRequestWithDbUser (const Aws::String &value)
 
ListDatabasesRequestWithDbUser (Aws::String &&value)
 
ListDatabasesRequestWithDbUser (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListDatabasesRequestWithMaxResults (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)
 
ListDatabasesRequestWithNextToken (const Aws::String &value)
 
ListDatabasesRequestWithNextToken (Aws::String &&value)
 
ListDatabasesRequestWithNextToken (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)
 
ListDatabasesRequestWithSecretArn (const Aws::String &value)
 
ListDatabasesRequestWithSecretArn (Aws::String &&value)
 
ListDatabasesRequestWithSecretArn (const char *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 ListDatabasesRequest.h.

Constructor & Destructor Documentation

◆ ListDatabasesRequest()

Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::ListDatabasesRequest ( )

Member Function Documentation

◆ ClusterIdentifierHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 ListDatabasesRequest.h.

◆ DatabaseHasBeenSet()

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

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

Definition at line 96 of file ListDatabasesRequest.h.

◆ DbUserHasBeenSet()

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

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

Definition at line 145 of file ListDatabasesRequest.h.

◆ GetClusterIdentifier()

const Aws::String& Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 ListDatabasesRequest.h.

◆ GetDatabase()

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

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

Definition at line 90 of file ListDatabasesRequest.h.

◆ GetDbUser()

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

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

Definition at line 139 of file ListDatabasesRequest.h.

◆ GetMaxResults()

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

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

Definition at line 189 of file ListDatabasesRequest.h.

◆ GetNextToken()

const Aws::String& Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 220 of file ListDatabasesRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetSecretArn()

const Aws::String& Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 290 of file ListDatabasesRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file ListDatabasesRequest.h.

◆ MaxResultsHasBeenSet()

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

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

Definition at line 196 of file ListDatabasesRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 229 of file ListDatabasesRequest.h.

◆ SecretArnHasBeenSet()

bool Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 296 of file ListDatabasesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClusterIdentifier() [1/3]

void Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 ListDatabasesRequest.h.

◆ SetClusterIdentifier() [2/3]

void Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 ListDatabasesRequest.h.

◆ SetClusterIdentifier() [3/3]

void Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 ListDatabasesRequest.h.

◆ SetDatabase() [1/3]

void Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 ListDatabasesRequest.h.

◆ SetDatabase() [2/3]

void Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 ListDatabasesRequest.h.

◆ SetDatabase() [3/3]

void Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 ListDatabasesRequest.h.

◆ SetDbUser() [1/3]

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

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

Definition at line 157 of file ListDatabasesRequest.h.

◆ SetDbUser() [2/3]

void Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 ListDatabasesRequest.h.

◆ SetDbUser() [3/3]

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

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

Definition at line 163 of file ListDatabasesRequest.h.

◆ SetMaxResults()

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

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

Definition at line 203 of file ListDatabasesRequest.h.

◆ SetNextToken() [1/3]

void Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 247 of file ListDatabasesRequest.h.

◆ SetNextToken() [2/3]

void Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 238 of file ListDatabasesRequest.h.

◆ SetNextToken() [3/3]

void Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 256 of file ListDatabasesRequest.h.

◆ SetSecretArn() [1/3]

void Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 308 of file ListDatabasesRequest.h.

◆ SetSecretArn() [2/3]

void Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 302 of file ListDatabasesRequest.h.

◆ SetSecretArn() [3/3]

void Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 314 of file ListDatabasesRequest.h.

◆ WithClusterIdentifier() [1/3]

ListDatabasesRequest& Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 ListDatabasesRequest.h.

◆ WithClusterIdentifier() [2/3]

ListDatabasesRequest& Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 ListDatabasesRequest.h.

◆ WithClusterIdentifier() [3/3]

ListDatabasesRequest& Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 ListDatabasesRequest.h.

◆ WithDatabase() [1/3]

ListDatabasesRequest& Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 ListDatabasesRequest.h.

◆ WithDatabase() [2/3]

ListDatabasesRequest& Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 ListDatabasesRequest.h.

◆ WithDatabase() [3/3]

ListDatabasesRequest& Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 ListDatabasesRequest.h.

◆ WithDbUser() [1/3]

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

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

Definition at line 175 of file ListDatabasesRequest.h.

◆ WithDbUser() [2/3]

ListDatabasesRequest& Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 ListDatabasesRequest.h.

◆ WithDbUser() [3/3]

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

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

Definition at line 181 of file ListDatabasesRequest.h.

◆ WithMaxResults()

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

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

Definition at line 210 of file ListDatabasesRequest.h.

◆ WithNextToken() [1/3]

ListDatabasesRequest& Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 274 of file ListDatabasesRequest.h.

◆ WithNextToken() [2/3]

ListDatabasesRequest& Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 265 of file ListDatabasesRequest.h.

◆ WithNextToken() [3/3]

ListDatabasesRequest& Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 283 of file ListDatabasesRequest.h.

◆ WithSecretArn() [1/3]

ListDatabasesRequest& Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 326 of file ListDatabasesRequest.h.

◆ WithSecretArn() [2/3]

ListDatabasesRequest& Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 320 of file ListDatabasesRequest.h.

◆ WithSecretArn() [3/3]

ListDatabasesRequest& Aws::RedshiftDataAPIService::Model::ListDatabasesRequest::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 332 of file ListDatabasesRequest.h.


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