AWS SDK for C++  1.9.18
AWS SDK for C++
Public Member Functions | List of all members
Aws::SecretsManager::Model::ListSecretsRequest Class Reference

#include <ListSecretsRequest.h>

+ Inheritance diagram for Aws::SecretsManager::Model::ListSecretsRequest:

Public Member Functions

 ListSecretsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListSecretsRequestWithMaxResults (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)
 
ListSecretsRequestWithNextToken (const Aws::String &value)
 
ListSecretsRequestWithNextToken (Aws::String &&value)
 
ListSecretsRequestWithNextToken (const char *value)
 
const Aws::Vector< Filter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< Filter > &value)
 
void SetFilters (Aws::Vector< Filter > &&value)
 
ListSecretsRequestWithFilters (const Aws::Vector< Filter > &value)
 
ListSecretsRequestWithFilters (Aws::Vector< Filter > &&value)
 
ListSecretsRequestAddFilters (const Filter &value)
 
ListSecretsRequestAddFilters (Filter &&value)
 
const SortOrderTypeGetSortOrder () const
 
bool SortOrderHasBeenSet () const
 
void SetSortOrder (const SortOrderType &value)
 
void SetSortOrder (SortOrderType &&value)
 
ListSecretsRequestWithSortOrder (const SortOrderType &value)
 
ListSecretsRequestWithSortOrder (SortOrderType &&value)
 
- Public Member Functions inherited from Aws::SecretsManager::SecretsManagerRequest
virtual ~SecretsManagerRequest ()
 
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 24 of file ListSecretsRequest.h.

Constructor & Destructor Documentation

◆ ListSecretsRequest()

Aws::SecretsManager::Model::ListSecretsRequest::ListSecretsRequest ( )

Member Function Documentation

◆ AddFilters() [1/2]

ListSecretsRequest& Aws::SecretsManager::Model::ListSecretsRequest::AddFilters ( const Filter value)
inline

Lists the secret request filters.

Definition at line 199 of file ListSecretsRequest.h.

◆ AddFilters() [2/2]

ListSecretsRequest& Aws::SecretsManager::Model::ListSecretsRequest::AddFilters ( Filter &&  value)
inline

Lists the secret request filters.

Definition at line 204 of file ListSecretsRequest.h.

◆ FiltersHasBeenSet()

bool Aws::SecretsManager::Model::ListSecretsRequest::FiltersHasBeenSet ( ) const
inline

Lists the secret request filters.

Definition at line 174 of file ListSecretsRequest.h.

◆ GetFilters()

const Aws::Vector<Filter>& Aws::SecretsManager::Model::ListSecretsRequest::GetFilters ( ) const
inline

Lists the secret request filters.

Definition at line 169 of file ListSecretsRequest.h.

◆ GetMaxResults()

int Aws::SecretsManager::Model::ListSecretsRequest::GetMaxResults ( ) const
inline

(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Definition at line 51 of file ListSecretsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::SecretsManager::Model::ListSecretsRequest::GetNextToken ( ) const
inline

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

Definition at line 100 of file ListSecretsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SecretsManager::Model::ListSecretsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::SecretsManager::Model::ListSecretsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file ListSecretsRequest.h.

◆ GetSortOrder()

const SortOrderType& Aws::SecretsManager::Model::ListSecretsRequest::GetSortOrder ( ) const
inline

Lists secrets in the requested order.

Definition at line 210 of file ListSecretsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::SecretsManager::Model::ListSecretsRequest::MaxResultsHasBeenSet ( ) const
inline

(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Definition at line 64 of file ListSecretsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::SecretsManager::Model::ListSecretsRequest::NextTokenHasBeenSet ( ) const
inline

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

Definition at line 109 of file ListSecretsRequest.h.

◆ SerializePayload()

Aws::String Aws::SecretsManager::Model::ListSecretsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetFilters() [1/2]

void Aws::SecretsManager::Model::ListSecretsRequest::SetFilters ( Aws::Vector< Filter > &&  value)
inline

Lists the secret request filters.

Definition at line 184 of file ListSecretsRequest.h.

◆ SetFilters() [2/2]

void Aws::SecretsManager::Model::ListSecretsRequest::SetFilters ( const Aws::Vector< Filter > &  value)
inline

Lists the secret request filters.

Definition at line 179 of file ListSecretsRequest.h.

◆ SetMaxResults()

void Aws::SecretsManager::Model::ListSecretsRequest::SetMaxResults ( int  value)
inline

(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Definition at line 77 of file ListSecretsRequest.h.

◆ SetNextToken() [1/3]

void Aws::SecretsManager::Model::ListSecretsRequest::SetNextToken ( Aws::String &&  value)
inline

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

Definition at line 127 of file ListSecretsRequest.h.

◆ SetNextToken() [2/3]

void Aws::SecretsManager::Model::ListSecretsRequest::SetNextToken ( const Aws::String value)
inline

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

Definition at line 118 of file ListSecretsRequest.h.

◆ SetNextToken() [3/3]

void Aws::SecretsManager::Model::ListSecretsRequest::SetNextToken ( const char *  value)
inline

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

Definition at line 136 of file ListSecretsRequest.h.

◆ SetSortOrder() [1/2]

void Aws::SecretsManager::Model::ListSecretsRequest::SetSortOrder ( const SortOrderType value)
inline

Lists secrets in the requested order.

Definition at line 220 of file ListSecretsRequest.h.

◆ SetSortOrder() [2/2]

void Aws::SecretsManager::Model::ListSecretsRequest::SetSortOrder ( SortOrderType &&  value)
inline

Lists secrets in the requested order.

Definition at line 225 of file ListSecretsRequest.h.

◆ SortOrderHasBeenSet()

bool Aws::SecretsManager::Model::ListSecretsRequest::SortOrderHasBeenSet ( ) const
inline

Lists secrets in the requested order.

Definition at line 215 of file ListSecretsRequest.h.

◆ WithFilters() [1/2]

ListSecretsRequest& Aws::SecretsManager::Model::ListSecretsRequest::WithFilters ( Aws::Vector< Filter > &&  value)
inline

Lists the secret request filters.

Definition at line 194 of file ListSecretsRequest.h.

◆ WithFilters() [2/2]

ListSecretsRequest& Aws::SecretsManager::Model::ListSecretsRequest::WithFilters ( const Aws::Vector< Filter > &  value)
inline

Lists the secret request filters.

Definition at line 189 of file ListSecretsRequest.h.

◆ WithMaxResults()

ListSecretsRequest& Aws::SecretsManager::Model::ListSecretsRequest::WithMaxResults ( int  value)
inline

(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Definition at line 90 of file ListSecretsRequest.h.

◆ WithNextToken() [1/3]

ListSecretsRequest& Aws::SecretsManager::Model::ListSecretsRequest::WithNextToken ( Aws::String &&  value)
inline

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

Definition at line 154 of file ListSecretsRequest.h.

◆ WithNextToken() [2/3]

ListSecretsRequest& Aws::SecretsManager::Model::ListSecretsRequest::WithNextToken ( const Aws::String value)
inline

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

Definition at line 145 of file ListSecretsRequest.h.

◆ WithNextToken() [3/3]

ListSecretsRequest& Aws::SecretsManager::Model::ListSecretsRequest::WithNextToken ( const char *  value)
inline

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

Definition at line 163 of file ListSecretsRequest.h.

◆ WithSortOrder() [1/2]

ListSecretsRequest& Aws::SecretsManager::Model::ListSecretsRequest::WithSortOrder ( const SortOrderType value)
inline

Lists secrets in the requested order.

Definition at line 230 of file ListSecretsRequest.h.

◆ WithSortOrder() [2/2]

ListSecretsRequest& Aws::SecretsManager::Model::ListSecretsRequest::WithSortOrder ( SortOrderType &&  value)
inline

Lists secrets in the requested order.

Definition at line 235 of file ListSecretsRequest.h.


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