AWS SDK for C++  1.9.108
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::Redshift::Model::DescribeClusterParametersRequest Class Reference

#include <DescribeClusterParametersRequest.h>

+ Inheritance diagram for Aws::Redshift::Model::DescribeClusterParametersRequest:

Public Member Functions

 DescribeClusterParametersRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetParameterGroupName () const
 
bool ParameterGroupNameHasBeenSet () const
 
void SetParameterGroupName (const Aws::String &value)
 
void SetParameterGroupName (Aws::String &&value)
 
void SetParameterGroupName (const char *value)
 
DescribeClusterParametersRequestWithParameterGroupName (const Aws::String &value)
 
DescribeClusterParametersRequestWithParameterGroupName (Aws::String &&value)
 
DescribeClusterParametersRequestWithParameterGroupName (const char *value)
 
const Aws::StringGetSource () const
 
bool SourceHasBeenSet () const
 
void SetSource (const Aws::String &value)
 
void SetSource (Aws::String &&value)
 
void SetSource (const char *value)
 
DescribeClusterParametersRequestWithSource (const Aws::String &value)
 
DescribeClusterParametersRequestWithSource (Aws::String &&value)
 
DescribeClusterParametersRequestWithSource (const char *value)
 
int GetMaxRecords () const
 
bool MaxRecordsHasBeenSet () const
 
void SetMaxRecords (int value)
 
DescribeClusterParametersRequestWithMaxRecords (int value)
 
const Aws::StringGetMarker () const
 
bool MarkerHasBeenSet () const
 
void SetMarker (const Aws::String &value)
 
void SetMarker (Aws::String &&value)
 
void SetMarker (const char *value)
 
DescribeClusterParametersRequestWithMarker (const Aws::String &value)
 
DescribeClusterParametersRequestWithMarker (Aws::String &&value)
 
DescribeClusterParametersRequestWithMarker (const char *value)
 
- Public Member Functions inherited from Aws::Redshift::RedshiftRequest
virtual ~RedshiftRequest ()
 
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
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::Redshift::RedshiftRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

See Also:

AWS API Reference

Definition at line 24 of file DescribeClusterParametersRequest.h.

Constructor & Destructor Documentation

◆ DescribeClusterParametersRequest()

Aws::Redshift::Model::DescribeClusterParametersRequest::DescribeClusterParametersRequest ( )

Member Function Documentation

◆ DumpBodyToUrl()

void Aws::Redshift::Model::DescribeClusterParametersRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetMarker()

const Aws::String& Aws::Redshift::Model::DescribeClusterParametersRequest::GetMarker ( ) const
inline

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Definition at line 205 of file DescribeClusterParametersRequest.h.

◆ GetMaxRecords()

int Aws::Redshift::Model::DescribeClusterParametersRequest::GetMaxRecords ( ) const
inline

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

Definition at line 164 of file DescribeClusterParametersRequest.h.

◆ GetParameterGroupName()

const Aws::String& Aws::Redshift::Model::DescribeClusterParametersRequest::GetParameterGroupName ( ) const
inline

The name of a cluster parameter group for which to return details.

Definition at line 45 of file DescribeClusterParametersRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Redshift::Model::DescribeClusterParametersRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file DescribeClusterParametersRequest.h.

◆ GetSource()

const Aws::String& Aws::Redshift::Model::DescribeClusterParametersRequest::GetSource ( ) const
inline

The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: user | engine-default

Definition at line 90 of file DescribeClusterParametersRequest.h.

◆ MarkerHasBeenSet()

bool Aws::Redshift::Model::DescribeClusterParametersRequest::MarkerHasBeenSet ( ) const
inline

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Definition at line 215 of file DescribeClusterParametersRequest.h.

◆ MaxRecordsHasBeenSet()

bool Aws::Redshift::Model::DescribeClusterParametersRequest::MaxRecordsHasBeenSet ( ) const
inline

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

Definition at line 174 of file DescribeClusterParametersRequest.h.

◆ ParameterGroupNameHasBeenSet()

bool Aws::Redshift::Model::DescribeClusterParametersRequest::ParameterGroupNameHasBeenSet ( ) const
inline

The name of a cluster parameter group for which to return details.

Definition at line 50 of file DescribeClusterParametersRequest.h.

◆ SerializePayload()

Aws::String Aws::Redshift::Model::DescribeClusterParametersRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetMarker() [1/3]

void Aws::Redshift::Model::DescribeClusterParametersRequest::SetMarker ( Aws::String &&  value)
inline

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Definition at line 235 of file DescribeClusterParametersRequest.h.

◆ SetMarker() [2/3]

void Aws::Redshift::Model::DescribeClusterParametersRequest::SetMarker ( const Aws::String value)
inline

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Definition at line 225 of file DescribeClusterParametersRequest.h.

◆ SetMarker() [3/3]

void Aws::Redshift::Model::DescribeClusterParametersRequest::SetMarker ( const char *  value)
inline

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Definition at line 245 of file DescribeClusterParametersRequest.h.

◆ SetMaxRecords()

void Aws::Redshift::Model::DescribeClusterParametersRequest::SetMaxRecords ( int  value)
inline

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

Definition at line 184 of file DescribeClusterParametersRequest.h.

◆ SetParameterGroupName() [1/3]

void Aws::Redshift::Model::DescribeClusterParametersRequest::SetParameterGroupName ( Aws::String &&  value)
inline

The name of a cluster parameter group for which to return details.

Definition at line 60 of file DescribeClusterParametersRequest.h.

◆ SetParameterGroupName() [2/3]

void Aws::Redshift::Model::DescribeClusterParametersRequest::SetParameterGroupName ( const Aws::String value)
inline

The name of a cluster parameter group for which to return details.

Definition at line 55 of file DescribeClusterParametersRequest.h.

◆ SetParameterGroupName() [3/3]

void Aws::Redshift::Model::DescribeClusterParametersRequest::SetParameterGroupName ( const char *  value)
inline

The name of a cluster parameter group for which to return details.

Definition at line 65 of file DescribeClusterParametersRequest.h.

◆ SetSource() [1/3]

void Aws::Redshift::Model::DescribeClusterParametersRequest::SetSource ( Aws::String &&  value)
inline

The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: user | engine-default

Definition at line 117 of file DescribeClusterParametersRequest.h.

◆ SetSource() [2/3]

void Aws::Redshift::Model::DescribeClusterParametersRequest::SetSource ( const Aws::String value)
inline

The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: user | engine-default

Definition at line 108 of file DescribeClusterParametersRequest.h.

◆ SetSource() [3/3]

void Aws::Redshift::Model::DescribeClusterParametersRequest::SetSource ( const char *  value)
inline

The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: user | engine-default

Definition at line 126 of file DescribeClusterParametersRequest.h.

◆ SourceHasBeenSet()

bool Aws::Redshift::Model::DescribeClusterParametersRequest::SourceHasBeenSet ( ) const
inline

The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: user | engine-default

Definition at line 99 of file DescribeClusterParametersRequest.h.

◆ WithMarker() [1/3]

DescribeClusterParametersRequest& Aws::Redshift::Model::DescribeClusterParametersRequest::WithMarker ( Aws::String &&  value)
inline

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Definition at line 265 of file DescribeClusterParametersRequest.h.

◆ WithMarker() [2/3]

DescribeClusterParametersRequest& Aws::Redshift::Model::DescribeClusterParametersRequest::WithMarker ( const Aws::String value)
inline

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Definition at line 255 of file DescribeClusterParametersRequest.h.

◆ WithMarker() [3/3]

DescribeClusterParametersRequest& Aws::Redshift::Model::DescribeClusterParametersRequest::WithMarker ( const char *  value)
inline

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Definition at line 275 of file DescribeClusterParametersRequest.h.

◆ WithMaxRecords()

DescribeClusterParametersRequest& Aws::Redshift::Model::DescribeClusterParametersRequest::WithMaxRecords ( int  value)
inline

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

Definition at line 194 of file DescribeClusterParametersRequest.h.

◆ WithParameterGroupName() [1/3]

DescribeClusterParametersRequest& Aws::Redshift::Model::DescribeClusterParametersRequest::WithParameterGroupName ( Aws::String &&  value)
inline

The name of a cluster parameter group for which to return details.

Definition at line 75 of file DescribeClusterParametersRequest.h.

◆ WithParameterGroupName() [2/3]

DescribeClusterParametersRequest& Aws::Redshift::Model::DescribeClusterParametersRequest::WithParameterGroupName ( const Aws::String value)
inline

The name of a cluster parameter group for which to return details.

Definition at line 70 of file DescribeClusterParametersRequest.h.

◆ WithParameterGroupName() [3/3]

DescribeClusterParametersRequest& Aws::Redshift::Model::DescribeClusterParametersRequest::WithParameterGroupName ( const char *  value)
inline

The name of a cluster parameter group for which to return details.

Definition at line 80 of file DescribeClusterParametersRequest.h.

◆ WithSource() [1/3]

DescribeClusterParametersRequest& Aws::Redshift::Model::DescribeClusterParametersRequest::WithSource ( Aws::String &&  value)
inline

The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: user | engine-default

Definition at line 144 of file DescribeClusterParametersRequest.h.

◆ WithSource() [2/3]

DescribeClusterParametersRequest& Aws::Redshift::Model::DescribeClusterParametersRequest::WithSource ( const Aws::String value)
inline

The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: user | engine-default

Definition at line 135 of file DescribeClusterParametersRequest.h.

◆ WithSource() [3/3]

DescribeClusterParametersRequest& Aws::Redshift::Model::DescribeClusterParametersRequest::WithSource ( const char *  value)
inline

The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

Default: All parameter types returned.

Valid Values: user | engine-default

Definition at line 153 of file DescribeClusterParametersRequest.h.


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