AWS SDK for C++  1.8.93
AWS SDK for C++
Public Member Functions | List of all members
Aws::ECS::Model::ListAttributesRequest Class Reference

#include <ListAttributesRequest.h>

+ Inheritance diagram for Aws::ECS::Model::ListAttributesRequest:

Public Member Functions

 ListAttributesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetCluster () const
 
bool ClusterHasBeenSet () const
 
void SetCluster (const Aws::String &value)
 
void SetCluster (Aws::String &&value)
 
void SetCluster (const char *value)
 
ListAttributesRequestWithCluster (const Aws::String &value)
 
ListAttributesRequestWithCluster (Aws::String &&value)
 
ListAttributesRequestWithCluster (const char *value)
 
const TargetTypeGetTargetType () const
 
bool TargetTypeHasBeenSet () const
 
void SetTargetType (const TargetType &value)
 
void SetTargetType (TargetType &&value)
 
ListAttributesRequestWithTargetType (const TargetType &value)
 
ListAttributesRequestWithTargetType (TargetType &&value)
 
const Aws::StringGetAttributeName () const
 
bool AttributeNameHasBeenSet () const
 
void SetAttributeName (const Aws::String &value)
 
void SetAttributeName (Aws::String &&value)
 
void SetAttributeName (const char *value)
 
ListAttributesRequestWithAttributeName (const Aws::String &value)
 
ListAttributesRequestWithAttributeName (Aws::String &&value)
 
ListAttributesRequestWithAttributeName (const char *value)
 
const Aws::StringGetAttributeValue () const
 
bool AttributeValueHasBeenSet () const
 
void SetAttributeValue (const Aws::String &value)
 
void SetAttributeValue (Aws::String &&value)
 
void SetAttributeValue (const char *value)
 
ListAttributesRequestWithAttributeValue (const Aws::String &value)
 
ListAttributesRequestWithAttributeValue (Aws::String &&value)
 
ListAttributesRequestWithAttributeValue (const char *value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListAttributesRequestWithNextToken (const Aws::String &value)
 
ListAttributesRequestWithNextToken (Aws::String &&value)
 
ListAttributesRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListAttributesRequestWithMaxResults (int value)
 
- Public Member Functions inherited from Aws::ECS::ECSRequest
virtual ~ECSRequest ()
 
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 ListAttributesRequest.h.

Constructor & Destructor Documentation

◆ ListAttributesRequest()

Aws::ECS::Model::ListAttributesRequest::ListAttributesRequest ( )

Member Function Documentation

◆ AttributeNameHasBeenSet()

bool Aws::ECS::Model::ListAttributesRequest::AttributeNameHasBeenSet ( ) const
inline

The name of the attribute with which to filter the results.

Definition at line 126 of file ListAttributesRequest.h.

◆ AttributeValueHasBeenSet()

bool Aws::ECS::Model::ListAttributesRequest::AttributeValueHasBeenSet ( ) const
inline

The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.

Definition at line 169 of file ListAttributesRequest.h.

◆ ClusterHasBeenSet()

bool Aws::ECS::Model::ListAttributesRequest::ClusterHasBeenSet ( ) const
inline

The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.

Definition at line 48 of file ListAttributesRequest.h.

◆ GetAttributeName()

const Aws::String& Aws::ECS::Model::ListAttributesRequest::GetAttributeName ( ) const
inline

The name of the attribute with which to filter the results.

Definition at line 121 of file ListAttributesRequest.h.

◆ GetAttributeValue()

const Aws::String& Aws::ECS::Model::ListAttributesRequest::GetAttributeValue ( ) const
inline

The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.

Definition at line 163 of file ListAttributesRequest.h.

◆ GetCluster()

const Aws::String& Aws::ECS::Model::ListAttributesRequest::GetCluster ( ) const
inline

The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.

Definition at line 42 of file ListAttributesRequest.h.

◆ GetMaxResults()

int Aws::ECS::Model::ListAttributesRequest::GetMaxResults ( ) const
inline

The maximum number of cluster results returned by ListAttributes in paginated output. When this parameter is used, ListAttributes only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

Definition at line 307 of file ListAttributesRequest.h.

◆ GetNextToken()

const Aws::String& Aws::ECS::Model::ListAttributesRequest::GetNextToken ( ) const
inline

The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 217 of file ListAttributesRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::ECS::Model::ListAttributesRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::ECS::ECSRequest.

◆ GetServiceRequestName()

virtual const char* Aws::ECS::Model::ListAttributesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file ListAttributesRequest.h.

◆ GetTargetType()

const TargetType& Aws::ECS::Model::ListAttributesRequest::GetTargetType ( ) const
inline

The type of the target with which to list attributes.

Definition at line 90 of file ListAttributesRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::ECS::Model::ListAttributesRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of cluster results returned by ListAttributes in paginated output. When this parameter is used, ListAttributes only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

Definition at line 319 of file ListAttributesRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::ECS::Model::ListAttributesRequest::NextTokenHasBeenSet ( ) const
inline

The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 228 of file ListAttributesRequest.h.

◆ SerializePayload()

Aws::String Aws::ECS::Model::ListAttributesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAttributeName() [1/3]

void Aws::ECS::Model::ListAttributesRequest::SetAttributeName ( const Aws::String value)
inline

The name of the attribute with which to filter the results.

Definition at line 131 of file ListAttributesRequest.h.

◆ SetAttributeName() [2/3]

void Aws::ECS::Model::ListAttributesRequest::SetAttributeName ( Aws::String &&  value)
inline

The name of the attribute with which to filter the results.

Definition at line 136 of file ListAttributesRequest.h.

◆ SetAttributeName() [3/3]

void Aws::ECS::Model::ListAttributesRequest::SetAttributeName ( const char *  value)
inline

The name of the attribute with which to filter the results.

Definition at line 141 of file ListAttributesRequest.h.

◆ SetAttributeValue() [1/3]

void Aws::ECS::Model::ListAttributesRequest::SetAttributeValue ( const Aws::String value)
inline

The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.

Definition at line 175 of file ListAttributesRequest.h.

◆ SetAttributeValue() [2/3]

void Aws::ECS::Model::ListAttributesRequest::SetAttributeValue ( Aws::String &&  value)
inline

The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.

Definition at line 181 of file ListAttributesRequest.h.

◆ SetAttributeValue() [3/3]

void Aws::ECS::Model::ListAttributesRequest::SetAttributeValue ( const char *  value)
inline

The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.

Definition at line 187 of file ListAttributesRequest.h.

◆ SetCluster() [1/3]

void Aws::ECS::Model::ListAttributesRequest::SetCluster ( const Aws::String value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.

Definition at line 54 of file ListAttributesRequest.h.

◆ SetCluster() [2/3]

void Aws::ECS::Model::ListAttributesRequest::SetCluster ( Aws::String &&  value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.

Definition at line 60 of file ListAttributesRequest.h.

◆ SetCluster() [3/3]

void Aws::ECS::Model::ListAttributesRequest::SetCluster ( const char *  value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.

Definition at line 66 of file ListAttributesRequest.h.

◆ SetMaxResults()

void Aws::ECS::Model::ListAttributesRequest::SetMaxResults ( int  value)
inline

The maximum number of cluster results returned by ListAttributes in paginated output. When this parameter is used, ListAttributes only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

Definition at line 331 of file ListAttributesRequest.h.

◆ SetNextToken() [1/3]

void Aws::ECS::Model::ListAttributesRequest::SetNextToken ( const Aws::String value)
inline

The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 239 of file ListAttributesRequest.h.

◆ SetNextToken() [2/3]

void Aws::ECS::Model::ListAttributesRequest::SetNextToken ( Aws::String &&  value)
inline

The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 250 of file ListAttributesRequest.h.

◆ SetNextToken() [3/3]

void Aws::ECS::Model::ListAttributesRequest::SetNextToken ( const char *  value)
inline

The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 261 of file ListAttributesRequest.h.

◆ SetTargetType() [1/2]

void Aws::ECS::Model::ListAttributesRequest::SetTargetType ( const TargetType value)
inline

The type of the target with which to list attributes.

Definition at line 100 of file ListAttributesRequest.h.

◆ SetTargetType() [2/2]

void Aws::ECS::Model::ListAttributesRequest::SetTargetType ( TargetType &&  value)
inline

The type of the target with which to list attributes.

Definition at line 105 of file ListAttributesRequest.h.

◆ TargetTypeHasBeenSet()

bool Aws::ECS::Model::ListAttributesRequest::TargetTypeHasBeenSet ( ) const
inline

The type of the target with which to list attributes.

Definition at line 95 of file ListAttributesRequest.h.

◆ WithAttributeName() [1/3]

ListAttributesRequest& Aws::ECS::Model::ListAttributesRequest::WithAttributeName ( const Aws::String value)
inline

The name of the attribute with which to filter the results.

Definition at line 146 of file ListAttributesRequest.h.

◆ WithAttributeName() [2/3]

ListAttributesRequest& Aws::ECS::Model::ListAttributesRequest::WithAttributeName ( Aws::String &&  value)
inline

The name of the attribute with which to filter the results.

Definition at line 151 of file ListAttributesRequest.h.

◆ WithAttributeName() [3/3]

ListAttributesRequest& Aws::ECS::Model::ListAttributesRequest::WithAttributeName ( const char *  value)
inline

The name of the attribute with which to filter the results.

Definition at line 156 of file ListAttributesRequest.h.

◆ WithAttributeValue() [1/3]

ListAttributesRequest& Aws::ECS::Model::ListAttributesRequest::WithAttributeValue ( const Aws::String value)
inline

The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.

Definition at line 193 of file ListAttributesRequest.h.

◆ WithAttributeValue() [2/3]

ListAttributesRequest& Aws::ECS::Model::ListAttributesRequest::WithAttributeValue ( Aws::String &&  value)
inline

The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.

Definition at line 199 of file ListAttributesRequest.h.

◆ WithAttributeValue() [3/3]

ListAttributesRequest& Aws::ECS::Model::ListAttributesRequest::WithAttributeValue ( const char *  value)
inline

The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.

Definition at line 205 of file ListAttributesRequest.h.

◆ WithCluster() [1/3]

ListAttributesRequest& Aws::ECS::Model::ListAttributesRequest::WithCluster ( const Aws::String value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.

Definition at line 72 of file ListAttributesRequest.h.

◆ WithCluster() [2/3]

ListAttributesRequest& Aws::ECS::Model::ListAttributesRequest::WithCluster ( Aws::String &&  value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.

Definition at line 78 of file ListAttributesRequest.h.

◆ WithCluster() [3/3]

ListAttributesRequest& Aws::ECS::Model::ListAttributesRequest::WithCluster ( const char *  value)
inline

The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.

Definition at line 84 of file ListAttributesRequest.h.

◆ WithMaxResults()

ListAttributesRequest& Aws::ECS::Model::ListAttributesRequest::WithMaxResults ( int  value)
inline

The maximum number of cluster results returned by ListAttributes in paginated output. When this parameter is used, ListAttributes only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

Definition at line 343 of file ListAttributesRequest.h.

◆ WithNextToken() [1/3]

ListAttributesRequest& Aws::ECS::Model::ListAttributesRequest::WithNextToken ( const Aws::String value)
inline

The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 272 of file ListAttributesRequest.h.

◆ WithNextToken() [2/3]

ListAttributesRequest& Aws::ECS::Model::ListAttributesRequest::WithNextToken ( Aws::String &&  value)
inline

The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 283 of file ListAttributesRequest.h.

◆ WithNextToken() [3/3]

ListAttributesRequest& Aws::ECS::Model::ListAttributesRequest::WithNextToken ( const char *  value)
inline

The nextToken value returned from a ListAttributes request indicating that more results are available to fulfill the request and further calls will be needed. If maxResults was provided, it is possible the number of results to be fewer than maxResults.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Definition at line 294 of file ListAttributesRequest.h.

◆ WithTargetType() [1/2]

ListAttributesRequest& Aws::ECS::Model::ListAttributesRequest::WithTargetType ( const TargetType value)
inline

The type of the target with which to list attributes.

Definition at line 110 of file ListAttributesRequest.h.

◆ WithTargetType() [2/2]

ListAttributesRequest& Aws::ECS::Model::ListAttributesRequest::WithTargetType ( TargetType &&  value)
inline

The type of the target with which to list attributes.

Definition at line 115 of file ListAttributesRequest.h.


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