AWS SDK for C++  1.8.59
AWS SDK for C++
Public Member Functions | List of all members
Aws::CognitoSync::Model::ListRecordsRequest Class Reference

#include <ListRecordsRequest.h>

+ Inheritance diagram for Aws::CognitoSync::Model::ListRecordsRequest:

Public Member Functions

 ListRecordsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
const Aws::StringGetIdentityPoolId () const
 
bool IdentityPoolIdHasBeenSet () const
 
void SetIdentityPoolId (const Aws::String &value)
 
void SetIdentityPoolId (Aws::String &&value)
 
void SetIdentityPoolId (const char *value)
 
ListRecordsRequestWithIdentityPoolId (const Aws::String &value)
 
ListRecordsRequestWithIdentityPoolId (Aws::String &&value)
 
ListRecordsRequestWithIdentityPoolId (const char *value)
 
const Aws::StringGetIdentityId () const
 
bool IdentityIdHasBeenSet () const
 
void SetIdentityId (const Aws::String &value)
 
void SetIdentityId (Aws::String &&value)
 
void SetIdentityId (const char *value)
 
ListRecordsRequestWithIdentityId (const Aws::String &value)
 
ListRecordsRequestWithIdentityId (Aws::String &&value)
 
ListRecordsRequestWithIdentityId (const char *value)
 
const Aws::StringGetDatasetName () const
 
bool DatasetNameHasBeenSet () const
 
void SetDatasetName (const Aws::String &value)
 
void SetDatasetName (Aws::String &&value)
 
void SetDatasetName (const char *value)
 
ListRecordsRequestWithDatasetName (const Aws::String &value)
 
ListRecordsRequestWithDatasetName (Aws::String &&value)
 
ListRecordsRequestWithDatasetName (const char *value)
 
long long GetLastSyncCount () const
 
bool LastSyncCountHasBeenSet () const
 
void SetLastSyncCount (long long value)
 
ListRecordsRequestWithLastSyncCount (long long value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListRecordsRequestWithNextToken (const Aws::String &value)
 
ListRecordsRequestWithNextToken (Aws::String &&value)
 
ListRecordsRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListRecordsRequestWithMaxResults (int value)
 
const Aws::StringGetSyncSessionToken () const
 
bool SyncSessionTokenHasBeenSet () const
 
void SetSyncSessionToken (const Aws::String &value)
 
void SetSyncSessionToken (Aws::String &&value)
 
void SetSyncSessionToken (const char *value)
 
ListRecordsRequestWithSyncSessionToken (const Aws::String &value)
 
ListRecordsRequestWithSyncSessionToken (Aws::String &&value)
 
ListRecordsRequestWithSyncSessionToken (const char *value)
 
- Public Member Functions inherited from Aws::CognitoSync::CognitoSyncRequest
virtual ~CognitoSyncRequest ()
 
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 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::CognitoSync::CognitoSyncRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

A request for a list of records.

See Also:

AWS API Reference

Definition at line 28 of file ListRecordsRequest.h.

Constructor & Destructor Documentation

◆ ListRecordsRequest()

Aws::CognitoSync::Model::ListRecordsRequest::ListRecordsRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::CognitoSync::Model::ListRecordsRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

◆ DatasetNameHasBeenSet()

bool Aws::CognitoSync::Model::ListRecordsRequest::DatasetNameHasBeenSet ( ) const
inline

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

Definition at line 152 of file ListRecordsRequest.h.

◆ GetDatasetName()

const Aws::String& Aws::CognitoSync::Model::ListRecordsRequest::GetDatasetName ( ) const
inline

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

Definition at line 146 of file ListRecordsRequest.h.

◆ GetIdentityId()

const Aws::String& Aws::CognitoSync::Model::ListRecordsRequest::GetIdentityId ( ) const
inline

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Definition at line 97 of file ListRecordsRequest.h.

◆ GetIdentityPoolId()

const Aws::String& Aws::CognitoSync::Model::ListRecordsRequest::GetIdentityPoolId ( ) const
inline

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Definition at line 48 of file ListRecordsRequest.h.

◆ GetLastSyncCount()

long long Aws::CognitoSync::Model::ListRecordsRequest::GetLastSyncCount ( ) const
inline

The last server sync count for this record.

Definition at line 194 of file ListRecordsRequest.h.

◆ GetMaxResults()

int Aws::CognitoSync::Model::ListRecordsRequest::GetMaxResults ( ) const
inline

The maximum number of results to be returned.

Definition at line 256 of file ListRecordsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::CognitoSync::Model::ListRecordsRequest::GetNextToken ( ) const
inline

A pagination token for obtaining the next page of results.

Definition at line 215 of file ListRecordsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::CognitoSync::Model::ListRecordsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file ListRecordsRequest.h.

◆ GetSyncSessionToken()

const Aws::String& Aws::CognitoSync::Model::ListRecordsRequest::GetSyncSessionToken ( ) const
inline

A token containing a session ID, identity ID, and expiration.

Definition at line 277 of file ListRecordsRequest.h.

◆ IdentityIdHasBeenSet()

bool Aws::CognitoSync::Model::ListRecordsRequest::IdentityIdHasBeenSet ( ) const
inline

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Definition at line 103 of file ListRecordsRequest.h.

◆ IdentityPoolIdHasBeenSet()

bool Aws::CognitoSync::Model::ListRecordsRequest::IdentityPoolIdHasBeenSet ( ) const
inline

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Definition at line 54 of file ListRecordsRequest.h.

◆ LastSyncCountHasBeenSet()

bool Aws::CognitoSync::Model::ListRecordsRequest::LastSyncCountHasBeenSet ( ) const
inline

The last server sync count for this record.

Definition at line 199 of file ListRecordsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::CognitoSync::Model::ListRecordsRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of results to be returned.

Definition at line 261 of file ListRecordsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::CognitoSync::Model::ListRecordsRequest::NextTokenHasBeenSet ( ) const
inline

A pagination token for obtaining the next page of results.

Definition at line 220 of file ListRecordsRequest.h.

◆ SerializePayload()

Aws::String Aws::CognitoSync::Model::ListRecordsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDatasetName() [1/3]

void Aws::CognitoSync::Model::ListRecordsRequest::SetDatasetName ( const Aws::String value)
inline

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

Definition at line 158 of file ListRecordsRequest.h.

◆ SetDatasetName() [2/3]

void Aws::CognitoSync::Model::ListRecordsRequest::SetDatasetName ( Aws::String &&  value)
inline

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

Definition at line 164 of file ListRecordsRequest.h.

◆ SetDatasetName() [3/3]

void Aws::CognitoSync::Model::ListRecordsRequest::SetDatasetName ( const char *  value)
inline

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

Definition at line 170 of file ListRecordsRequest.h.

◆ SetIdentityId() [1/3]

void Aws::CognitoSync::Model::ListRecordsRequest::SetIdentityId ( const Aws::String value)
inline

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Definition at line 109 of file ListRecordsRequest.h.

◆ SetIdentityId() [2/3]

void Aws::CognitoSync::Model::ListRecordsRequest::SetIdentityId ( Aws::String &&  value)
inline

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Definition at line 115 of file ListRecordsRequest.h.

◆ SetIdentityId() [3/3]

void Aws::CognitoSync::Model::ListRecordsRequest::SetIdentityId ( const char *  value)
inline

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Definition at line 121 of file ListRecordsRequest.h.

◆ SetIdentityPoolId() [1/3]

void Aws::CognitoSync::Model::ListRecordsRequest::SetIdentityPoolId ( const Aws::String value)
inline

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Definition at line 60 of file ListRecordsRequest.h.

◆ SetIdentityPoolId() [2/3]

void Aws::CognitoSync::Model::ListRecordsRequest::SetIdentityPoolId ( Aws::String &&  value)
inline

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Definition at line 66 of file ListRecordsRequest.h.

◆ SetIdentityPoolId() [3/3]

void Aws::CognitoSync::Model::ListRecordsRequest::SetIdentityPoolId ( const char *  value)
inline

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Definition at line 72 of file ListRecordsRequest.h.

◆ SetLastSyncCount()

void Aws::CognitoSync::Model::ListRecordsRequest::SetLastSyncCount ( long long  value)
inline

The last server sync count for this record.

Definition at line 204 of file ListRecordsRequest.h.

◆ SetMaxResults()

void Aws::CognitoSync::Model::ListRecordsRequest::SetMaxResults ( int  value)
inline

The maximum number of results to be returned.

Definition at line 266 of file ListRecordsRequest.h.

◆ SetNextToken() [1/3]

void Aws::CognitoSync::Model::ListRecordsRequest::SetNextToken ( const Aws::String value)
inline

A pagination token for obtaining the next page of results.

Definition at line 225 of file ListRecordsRequest.h.

◆ SetNextToken() [2/3]

void Aws::CognitoSync::Model::ListRecordsRequest::SetNextToken ( Aws::String &&  value)
inline

A pagination token for obtaining the next page of results.

Definition at line 230 of file ListRecordsRequest.h.

◆ SetNextToken() [3/3]

void Aws::CognitoSync::Model::ListRecordsRequest::SetNextToken ( const char *  value)
inline

A pagination token for obtaining the next page of results.

Definition at line 235 of file ListRecordsRequest.h.

◆ SetSyncSessionToken() [1/3]

void Aws::CognitoSync::Model::ListRecordsRequest::SetSyncSessionToken ( const Aws::String value)
inline

A token containing a session ID, identity ID, and expiration.

Definition at line 287 of file ListRecordsRequest.h.

◆ SetSyncSessionToken() [2/3]

void Aws::CognitoSync::Model::ListRecordsRequest::SetSyncSessionToken ( Aws::String &&  value)
inline

A token containing a session ID, identity ID, and expiration.

Definition at line 292 of file ListRecordsRequest.h.

◆ SetSyncSessionToken() [3/3]

void Aws::CognitoSync::Model::ListRecordsRequest::SetSyncSessionToken ( const char *  value)
inline

A token containing a session ID, identity ID, and expiration.

Definition at line 297 of file ListRecordsRequest.h.

◆ SyncSessionTokenHasBeenSet()

bool Aws::CognitoSync::Model::ListRecordsRequest::SyncSessionTokenHasBeenSet ( ) const
inline

A token containing a session ID, identity ID, and expiration.

Definition at line 282 of file ListRecordsRequest.h.

◆ WithDatasetName() [1/3]

ListRecordsRequest& Aws::CognitoSync::Model::ListRecordsRequest::WithDatasetName ( const Aws::String value)
inline

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

Definition at line 176 of file ListRecordsRequest.h.

◆ WithDatasetName() [2/3]

ListRecordsRequest& Aws::CognitoSync::Model::ListRecordsRequest::WithDatasetName ( Aws::String &&  value)
inline

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

Definition at line 182 of file ListRecordsRequest.h.

◆ WithDatasetName() [3/3]

ListRecordsRequest& Aws::CognitoSync::Model::ListRecordsRequest::WithDatasetName ( const char *  value)
inline

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

Definition at line 188 of file ListRecordsRequest.h.

◆ WithIdentityId() [1/3]

ListRecordsRequest& Aws::CognitoSync::Model::ListRecordsRequest::WithIdentityId ( const Aws::String value)
inline

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Definition at line 127 of file ListRecordsRequest.h.

◆ WithIdentityId() [2/3]

ListRecordsRequest& Aws::CognitoSync::Model::ListRecordsRequest::WithIdentityId ( Aws::String &&  value)
inline

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Definition at line 133 of file ListRecordsRequest.h.

◆ WithIdentityId() [3/3]

ListRecordsRequest& Aws::CognitoSync::Model::ListRecordsRequest::WithIdentityId ( const char *  value)
inline

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Definition at line 139 of file ListRecordsRequest.h.

◆ WithIdentityPoolId() [1/3]

ListRecordsRequest& Aws::CognitoSync::Model::ListRecordsRequest::WithIdentityPoolId ( const Aws::String value)
inline

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Definition at line 78 of file ListRecordsRequest.h.

◆ WithIdentityPoolId() [2/3]

ListRecordsRequest& Aws::CognitoSync::Model::ListRecordsRequest::WithIdentityPoolId ( Aws::String &&  value)
inline

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Definition at line 84 of file ListRecordsRequest.h.

◆ WithIdentityPoolId() [3/3]

ListRecordsRequest& Aws::CognitoSync::Model::ListRecordsRequest::WithIdentityPoolId ( const char *  value)
inline

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.

Definition at line 90 of file ListRecordsRequest.h.

◆ WithLastSyncCount()

ListRecordsRequest& Aws::CognitoSync::Model::ListRecordsRequest::WithLastSyncCount ( long long  value)
inline

The last server sync count for this record.

Definition at line 209 of file ListRecordsRequest.h.

◆ WithMaxResults()

ListRecordsRequest& Aws::CognitoSync::Model::ListRecordsRequest::WithMaxResults ( int  value)
inline

The maximum number of results to be returned.

Definition at line 271 of file ListRecordsRequest.h.

◆ WithNextToken() [1/3]

ListRecordsRequest& Aws::CognitoSync::Model::ListRecordsRequest::WithNextToken ( const Aws::String value)
inline

A pagination token for obtaining the next page of results.

Definition at line 240 of file ListRecordsRequest.h.

◆ WithNextToken() [2/3]

ListRecordsRequest& Aws::CognitoSync::Model::ListRecordsRequest::WithNextToken ( Aws::String &&  value)
inline

A pagination token for obtaining the next page of results.

Definition at line 245 of file ListRecordsRequest.h.

◆ WithNextToken() [3/3]

ListRecordsRequest& Aws::CognitoSync::Model::ListRecordsRequest::WithNextToken ( const char *  value)
inline

A pagination token for obtaining the next page of results.

Definition at line 250 of file ListRecordsRequest.h.

◆ WithSyncSessionToken() [1/3]

ListRecordsRequest& Aws::CognitoSync::Model::ListRecordsRequest::WithSyncSessionToken ( const Aws::String value)
inline

A token containing a session ID, identity ID, and expiration.

Definition at line 302 of file ListRecordsRequest.h.

◆ WithSyncSessionToken() [2/3]

ListRecordsRequest& Aws::CognitoSync::Model::ListRecordsRequest::WithSyncSessionToken ( Aws::String &&  value)
inline

A token containing a session ID, identity ID, and expiration.

Definition at line 307 of file ListRecordsRequest.h.

◆ WithSyncSessionToken() [3/3]

ListRecordsRequest& Aws::CognitoSync::Model::ListRecordsRequest::WithSyncSessionToken ( const char *  value)
inline

A token containing a session ID, identity ID, and expiration.

Definition at line 312 of file ListRecordsRequest.h.


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