AWS SDK for C++  1.8.54
AWS SDK for C++
Public Member Functions | List of all members
Aws::MediaStoreData::Model::ListItemsRequest Class Reference

#include <ListItemsRequest.h>

+ Inheritance diagram for Aws::MediaStoreData::Model::ListItemsRequest:

Public Member Functions

 ListItemsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
const Aws::StringGetPath () const
 
bool PathHasBeenSet () const
 
void SetPath (const Aws::String &value)
 
void SetPath (Aws::String &&value)
 
void SetPath (const char *value)
 
ListItemsRequestWithPath (const Aws::String &value)
 
ListItemsRequestWithPath (Aws::String &&value)
 
ListItemsRequestWithPath (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListItemsRequestWithMaxResults (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)
 
ListItemsRequestWithNextToken (const Aws::String &value)
 
ListItemsRequestWithNextToken (Aws::String &&value)
 
ListItemsRequestWithNextToken (const char *value)
 
- Public Member Functions inherited from Aws::MediaStoreData::MediaStoreDataRequest
virtual ~MediaStoreDataRequest ()
 
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::MediaStoreData::MediaStoreDataRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 25 of file ListItemsRequest.h.

Constructor & Destructor Documentation

◆ ListItemsRequest()

Aws::MediaStoreData::Model::ListItemsRequest::ListItemsRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::MediaStoreData::Model::ListItemsRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetMaxResults()

int Aws::MediaStoreData::Model::ListItemsRequest::GetMaxResults ( ) const
inline

The maximum number of results to return per API request. For example, you submit a ListItems request with MaxResults set at 500. Although 2,000 items match your request, the service returns no more than the first 500 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value.

If MaxResults is not included in the request, the service defaults to pagination with a maximum of 1,000 results per page.

Definition at line 100 of file ListItemsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::MediaStoreData::Model::ListItemsRequest::GetNextToken ( ) const
inline

The token that identifies which batch of results that you want to see. For example, you submit a ListItems request with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value. To see the next batch of results, you can submit the ListItems request a second time and specify the NextToken value.

Tokens expire after 15 minutes.

Definition at line 148 of file ListItemsRequest.h.

◆ GetPath()

const Aws::String& Aws::MediaStoreData::Model::ListItemsRequest::GetPath ( ) const
inline

The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>

Definition at line 45 of file ListItemsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::MediaStoreData::Model::ListItemsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file ListItemsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::MediaStoreData::Model::ListItemsRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of results to return per API request. For example, you submit a ListItems request with MaxResults set at 500. Although 2,000 items match your request, the service returns no more than the first 500 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value.

If MaxResults is not included in the request, the service defaults to pagination with a maximum of 1,000 results per page.

Definition at line 112 of file ListItemsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::MediaStoreData::Model::ListItemsRequest::NextTokenHasBeenSet ( ) const
inline

The token that identifies which batch of results that you want to see. For example, you submit a ListItems request with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value. To see the next batch of results, you can submit the ListItems request a second time and specify the NextToken value.

Tokens expire after 15 minutes.

Definition at line 159 of file ListItemsRequest.h.

◆ PathHasBeenSet()

bool Aws::MediaStoreData::Model::ListItemsRequest::PathHasBeenSet ( ) const
inline

The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>

Definition at line 51 of file ListItemsRequest.h.

◆ SerializePayload()

Aws::String Aws::MediaStoreData::Model::ListItemsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetMaxResults()

void Aws::MediaStoreData::Model::ListItemsRequest::SetMaxResults ( int  value)
inline

The maximum number of results to return per API request. For example, you submit a ListItems request with MaxResults set at 500. Although 2,000 items match your request, the service returns no more than the first 500 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value.

If MaxResults is not included in the request, the service defaults to pagination with a maximum of 1,000 results per page.

Definition at line 124 of file ListItemsRequest.h.

◆ SetNextToken() [1/3]

void Aws::MediaStoreData::Model::ListItemsRequest::SetNextToken ( const Aws::String value)
inline

The token that identifies which batch of results that you want to see. For example, you submit a ListItems request with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value. To see the next batch of results, you can submit the ListItems request a second time and specify the NextToken value.

Tokens expire after 15 minutes.

Definition at line 170 of file ListItemsRequest.h.

◆ SetNextToken() [2/3]

void Aws::MediaStoreData::Model::ListItemsRequest::SetNextToken ( Aws::String &&  value)
inline

The token that identifies which batch of results that you want to see. For example, you submit a ListItems request with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value. To see the next batch of results, you can submit the ListItems request a second time and specify the NextToken value.

Tokens expire after 15 minutes.

Definition at line 181 of file ListItemsRequest.h.

◆ SetNextToken() [3/3]

void Aws::MediaStoreData::Model::ListItemsRequest::SetNextToken ( const char *  value)
inline

The token that identifies which batch of results that you want to see. For example, you submit a ListItems request with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value. To see the next batch of results, you can submit the ListItems request a second time and specify the NextToken value.

Tokens expire after 15 minutes.

Definition at line 192 of file ListItemsRequest.h.

◆ SetPath() [1/3]

void Aws::MediaStoreData::Model::ListItemsRequest::SetPath ( const Aws::String value)
inline

The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>

Definition at line 57 of file ListItemsRequest.h.

◆ SetPath() [2/3]

void Aws::MediaStoreData::Model::ListItemsRequest::SetPath ( Aws::String &&  value)
inline

The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>

Definition at line 63 of file ListItemsRequest.h.

◆ SetPath() [3/3]

void Aws::MediaStoreData::Model::ListItemsRequest::SetPath ( const char *  value)
inline

The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>

Definition at line 69 of file ListItemsRequest.h.

◆ WithMaxResults()

ListItemsRequest& Aws::MediaStoreData::Model::ListItemsRequest::WithMaxResults ( int  value)
inline

The maximum number of results to return per API request. For example, you submit a ListItems request with MaxResults set at 500. Although 2,000 items match your request, the service returns no more than the first 500 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value.

If MaxResults is not included in the request, the service defaults to pagination with a maximum of 1,000 results per page.

Definition at line 136 of file ListItemsRequest.h.

◆ WithNextToken() [1/3]

ListItemsRequest& Aws::MediaStoreData::Model::ListItemsRequest::WithNextToken ( const Aws::String value)
inline

The token that identifies which batch of results that you want to see. For example, you submit a ListItems request with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value. To see the next batch of results, you can submit the ListItems request a second time and specify the NextToken value.

Tokens expire after 15 minutes.

Definition at line 203 of file ListItemsRequest.h.

◆ WithNextToken() [2/3]

ListItemsRequest& Aws::MediaStoreData::Model::ListItemsRequest::WithNextToken ( Aws::String &&  value)
inline

The token that identifies which batch of results that you want to see. For example, you submit a ListItems request with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value. To see the next batch of results, you can submit the ListItems request a second time and specify the NextToken value.

Tokens expire after 15 minutes.

Definition at line 214 of file ListItemsRequest.h.

◆ WithNextToken() [3/3]

ListItemsRequest& Aws::MediaStoreData::Model::ListItemsRequest::WithNextToken ( const char *  value)
inline

The token that identifies which batch of results that you want to see. For example, you submit a ListItems request with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value. To see the next batch of results, you can submit the ListItems request a second time and specify the NextToken value.

Tokens expire after 15 minutes.

Definition at line 225 of file ListItemsRequest.h.

◆ WithPath() [1/3]

ListItemsRequest& Aws::MediaStoreData::Model::ListItemsRequest::WithPath ( const Aws::String value)
inline

The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>

Definition at line 75 of file ListItemsRequest.h.

◆ WithPath() [2/3]

ListItemsRequest& Aws::MediaStoreData::Model::ListItemsRequest::WithPath ( Aws::String &&  value)
inline

The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>

Definition at line 81 of file ListItemsRequest.h.

◆ WithPath() [3/3]

ListItemsRequest& Aws::MediaStoreData::Model::ListItemsRequest::WithPath ( const char *  value)
inline

The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>

Definition at line 87 of file ListItemsRequest.h.


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