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

#include <ListTaskDefinitionsRequest.h>

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

Public Member Functions

 ListTaskDefinitionsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetFamilyPrefix () const
 
bool FamilyPrefixHasBeenSet () const
 
void SetFamilyPrefix (const Aws::String &value)
 
void SetFamilyPrefix (Aws::String &&value)
 
void SetFamilyPrefix (const char *value)
 
ListTaskDefinitionsRequestWithFamilyPrefix (const Aws::String &value)
 
ListTaskDefinitionsRequestWithFamilyPrefix (Aws::String &&value)
 
ListTaskDefinitionsRequestWithFamilyPrefix (const char *value)
 
const TaskDefinitionStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const TaskDefinitionStatus &value)
 
void SetStatus (TaskDefinitionStatus &&value)
 
ListTaskDefinitionsRequestWithStatus (const TaskDefinitionStatus &value)
 
ListTaskDefinitionsRequestWithStatus (TaskDefinitionStatus &&value)
 
const SortOrderGetSort () const
 
bool SortHasBeenSet () const
 
void SetSort (const SortOrder &value)
 
void SetSort (SortOrder &&value)
 
ListTaskDefinitionsRequestWithSort (const SortOrder &value)
 
ListTaskDefinitionsRequestWithSort (SortOrder &&value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListTaskDefinitionsRequestWithNextToken (const Aws::String &value)
 
ListTaskDefinitionsRequestWithNextToken (Aws::String &&value)
 
ListTaskDefinitionsRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListTaskDefinitionsRequestWithMaxResults (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 23 of file ListTaskDefinitionsRequest.h.

Constructor & Destructor Documentation

◆ ListTaskDefinitionsRequest()

Aws::ECS::Model::ListTaskDefinitionsRequest::ListTaskDefinitionsRequest ( )

Member Function Documentation

◆ FamilyPrefixHasBeenSet()

bool Aws::ECS::Model::ListTaskDefinitionsRequest::FamilyPrefixHasBeenSet ( ) const
inline

The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

Definition at line 53 of file ListTaskDefinitionsRequest.h.

◆ GetFamilyPrefix()

const Aws::String& Aws::ECS::Model::ListTaskDefinitionsRequest::GetFamilyPrefix ( ) const
inline

The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

Definition at line 45 of file ListTaskDefinitionsRequest.h.

◆ GetMaxResults()

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

The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions 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 ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.

Definition at line 332 of file ListTaskDefinitionsRequest.h.

◆ GetNextToken()

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

The nextToken value returned from a ListTaskDefinitions 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 241 of file ListTaskDefinitionsRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::ECS::ECSRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file ListTaskDefinitionsRequest.h.

◆ GetSort()

const SortOrder& Aws::ECS::Model::ListTaskDefinitionsRequest::GetSort ( ) const
inline

The order in which to sort the results. Valid values are ASC and DESC. By default (ASC), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.

Definition at line 179 of file ListTaskDefinitionsRequest.h.

◆ GetStatus()

const TaskDefinitionStatus& Aws::ECS::Model::ListTaskDefinitionsRequest::GetStatus ( ) const
inline

The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

Definition at line 113 of file ListTaskDefinitionsRequest.h.

◆ MaxResultsHasBeenSet()

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

The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions 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 ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.

Definition at line 345 of file ListTaskDefinitionsRequest.h.

◆ NextTokenHasBeenSet()

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

The nextToken value returned from a ListTaskDefinitions 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 252 of file ListTaskDefinitionsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFamilyPrefix() [1/3]

void Aws::ECS::Model::ListTaskDefinitionsRequest::SetFamilyPrefix ( const Aws::String value)
inline

The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

Definition at line 61 of file ListTaskDefinitionsRequest.h.

◆ SetFamilyPrefix() [2/3]

void Aws::ECS::Model::ListTaskDefinitionsRequest::SetFamilyPrefix ( Aws::String &&  value)
inline

The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

Definition at line 69 of file ListTaskDefinitionsRequest.h.

◆ SetFamilyPrefix() [3/3]

void Aws::ECS::Model::ListTaskDefinitionsRequest::SetFamilyPrefix ( const char *  value)
inline

The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

Definition at line 77 of file ListTaskDefinitionsRequest.h.

◆ SetMaxResults()

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

The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions 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 ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.

Definition at line 358 of file ListTaskDefinitionsRequest.h.

◆ SetNextToken() [1/3]

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

The nextToken value returned from a ListTaskDefinitions 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 263 of file ListTaskDefinitionsRequest.h.

◆ SetNextToken() [2/3]

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

The nextToken value returned from a ListTaskDefinitions 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 274 of file ListTaskDefinitionsRequest.h.

◆ SetNextToken() [3/3]

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

The nextToken value returned from a ListTaskDefinitions 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 285 of file ListTaskDefinitionsRequest.h.

◆ SetSort() [1/2]

void Aws::ECS::Model::ListTaskDefinitionsRequest::SetSort ( const SortOrder value)
inline

The order in which to sort the results. Valid values are ASC and DESC. By default (ASC), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.

Definition at line 199 of file ListTaskDefinitionsRequest.h.

◆ SetSort() [2/2]

void Aws::ECS::Model::ListTaskDefinitionsRequest::SetSort ( SortOrder &&  value)
inline

The order in which to sort the results. Valid values are ASC and DESC. By default (ASC), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.

Definition at line 209 of file ListTaskDefinitionsRequest.h.

◆ SetStatus() [1/2]

void Aws::ECS::Model::ListTaskDefinitionsRequest::SetStatus ( const TaskDefinitionStatus value)
inline

The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

Definition at line 135 of file ListTaskDefinitionsRequest.h.

◆ SetStatus() [2/2]

void Aws::ECS::Model::ListTaskDefinitionsRequest::SetStatus ( TaskDefinitionStatus &&  value)
inline

The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

Definition at line 146 of file ListTaskDefinitionsRequest.h.

◆ SortHasBeenSet()

bool Aws::ECS::Model::ListTaskDefinitionsRequest::SortHasBeenSet ( ) const
inline

The order in which to sort the results. Valid values are ASC and DESC. By default (ASC), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.

Definition at line 189 of file ListTaskDefinitionsRequest.h.

◆ StatusHasBeenSet()

bool Aws::ECS::Model::ListTaskDefinitionsRequest::StatusHasBeenSet ( ) const
inline

The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

Definition at line 124 of file ListTaskDefinitionsRequest.h.

◆ WithFamilyPrefix() [1/3]

ListTaskDefinitionsRequest& Aws::ECS::Model::ListTaskDefinitionsRequest::WithFamilyPrefix ( const Aws::String value)
inline

The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

Definition at line 85 of file ListTaskDefinitionsRequest.h.

◆ WithFamilyPrefix() [2/3]

ListTaskDefinitionsRequest& Aws::ECS::Model::ListTaskDefinitionsRequest::WithFamilyPrefix ( Aws::String &&  value)
inline

The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

Definition at line 93 of file ListTaskDefinitionsRequest.h.

◆ WithFamilyPrefix() [3/3]

ListTaskDefinitionsRequest& Aws::ECS::Model::ListTaskDefinitionsRequest::WithFamilyPrefix ( const char *  value)
inline

The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

Definition at line 101 of file ListTaskDefinitionsRequest.h.

◆ WithMaxResults()

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

The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions 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 ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.

Definition at line 371 of file ListTaskDefinitionsRequest.h.

◆ WithNextToken() [1/3]

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

The nextToken value returned from a ListTaskDefinitions 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 296 of file ListTaskDefinitionsRequest.h.

◆ WithNextToken() [2/3]

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

The nextToken value returned from a ListTaskDefinitions 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 307 of file ListTaskDefinitionsRequest.h.

◆ WithNextToken() [3/3]

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

The nextToken value returned from a ListTaskDefinitions 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 318 of file ListTaskDefinitionsRequest.h.

◆ WithSort() [1/2]

ListTaskDefinitionsRequest& Aws::ECS::Model::ListTaskDefinitionsRequest::WithSort ( const SortOrder value)
inline

The order in which to sort the results. Valid values are ASC and DESC. By default (ASC), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.

Definition at line 219 of file ListTaskDefinitionsRequest.h.

◆ WithSort() [2/2]

ListTaskDefinitionsRequest& Aws::ECS::Model::ListTaskDefinitionsRequest::WithSort ( SortOrder &&  value)
inline

The order in which to sort the results. Valid values are ASC and DESC. By default (ASC), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.

Definition at line 229 of file ListTaskDefinitionsRequest.h.

◆ WithStatus() [1/2]

ListTaskDefinitionsRequest& Aws::ECS::Model::ListTaskDefinitionsRequest::WithStatus ( const TaskDefinitionStatus value)
inline

The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

Definition at line 157 of file ListTaskDefinitionsRequest.h.

◆ WithStatus() [2/2]

ListTaskDefinitionsRequest& Aws::ECS::Model::ListTaskDefinitionsRequest::WithStatus ( TaskDefinitionStatus &&  value)
inline

The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

Definition at line 168 of file ListTaskDefinitionsRequest.h.


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