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

#include <ListAssetsRequest.h>

+ Inheritance diagram for Aws::IoTSiteWise::Model::ListAssetsRequest:

Public Member Functions

 ListAssetsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListAssetsRequestWithNextToken (const Aws::String &value)
 
ListAssetsRequestWithNextToken (Aws::String &&value)
 
ListAssetsRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListAssetsRequestWithMaxResults (int value)
 
const Aws::StringGetAssetModelId () const
 
bool AssetModelIdHasBeenSet () const
 
void SetAssetModelId (const Aws::String &value)
 
void SetAssetModelId (Aws::String &&value)
 
void SetAssetModelId (const char *value)
 
ListAssetsRequestWithAssetModelId (const Aws::String &value)
 
ListAssetsRequestWithAssetModelId (Aws::String &&value)
 
ListAssetsRequestWithAssetModelId (const char *value)
 
const ListAssetsFilterGetFilter () const
 
bool FilterHasBeenSet () const
 
void SetFilter (const ListAssetsFilter &value)
 
void SetFilter (ListAssetsFilter &&value)
 
ListAssetsRequestWithFilter (const ListAssetsFilter &value)
 
ListAssetsRequestWithFilter (ListAssetsFilter &&value)
 
- Public Member Functions inherited from Aws::IoTSiteWise::IoTSiteWiseRequest
virtual ~IoTSiteWiseRequest ()
 
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::IoTSiteWise::IoTSiteWiseRequest
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 26 of file ListAssetsRequest.h.

Constructor & Destructor Documentation

◆ ListAssetsRequest()

Aws::IoTSiteWise::Model::ListAssetsRequest::ListAssetsRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::IoTSiteWise::Model::ListAssetsRequest::AddQueryStringParameters ( Aws::Http::URI uri) const
overridevirtual

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ AssetModelIdHasBeenSet()

bool Aws::IoTSiteWise::Model::ListAssetsRequest::AssetModelIdHasBeenSet ( ) const
inline

The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter.

Definition at line 120 of file ListAssetsRequest.h.

◆ FilterHasBeenSet()

bool Aws::IoTSiteWise::Model::ListAssetsRequest::FilterHasBeenSet ( ) const
inline

The filter for the requested list of assets. Choose one of the following options:

  • ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.

  • TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

Default: ALL

Definition at line 183 of file ListAssetsRequest.h.

◆ GetAssetModelId()

const Aws::String& Aws::IoTSiteWise::Model::ListAssetsRequest::GetAssetModelId ( ) const
inline

The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter.

Definition at line 113 of file ListAssetsRequest.h.

◆ GetFilter()

const ListAssetsFilter& Aws::IoTSiteWise::Model::ListAssetsRequest::GetFilter ( ) const
inline

The filter for the requested list of assets. Choose one of the following options:

  • ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.

  • TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

Default: ALL

Definition at line 173 of file ListAssetsRequest.h.

◆ GetMaxResults()

int Aws::IoTSiteWise::Model::ListAssetsRequest::GetMaxResults ( ) const
inline

The maximum number of results to be returned per paginated request.

Default: 50

Definition at line 87 of file ListAssetsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::IoTSiteWise::Model::ListAssetsRequest::GetNextToken ( ) const
inline

The token to be used for the next set of paginated results.

Definition at line 45 of file ListAssetsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::IoTSiteWise::Model::ListAssetsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file ListAssetsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::IoTSiteWise::Model::ListAssetsRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of results to be returned per paginated request.

Default: 50

Definition at line 93 of file ListAssetsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::IoTSiteWise::Model::ListAssetsRequest::NextTokenHasBeenSet ( ) const
inline

The token to be used for the next set of paginated results.

Definition at line 50 of file ListAssetsRequest.h.

◆ SerializePayload()

Aws::String Aws::IoTSiteWise::Model::ListAssetsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAssetModelId() [1/3]

void Aws::IoTSiteWise::Model::ListAssetsRequest::SetAssetModelId ( const Aws::String value)
inline

The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter.

Definition at line 127 of file ListAssetsRequest.h.

◆ SetAssetModelId() [2/3]

void Aws::IoTSiteWise::Model::ListAssetsRequest::SetAssetModelId ( Aws::String &&  value)
inline

The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter.

Definition at line 134 of file ListAssetsRequest.h.

◆ SetAssetModelId() [3/3]

void Aws::IoTSiteWise::Model::ListAssetsRequest::SetAssetModelId ( const char *  value)
inline

The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter.

Definition at line 141 of file ListAssetsRequest.h.

◆ SetFilter() [1/2]

void Aws::IoTSiteWise::Model::ListAssetsRequest::SetFilter ( const ListAssetsFilter value)
inline

The filter for the requested list of assets. Choose one of the following options:

  • ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.

  • TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

Default: ALL

Definition at line 193 of file ListAssetsRequest.h.

◆ SetFilter() [2/2]

void Aws::IoTSiteWise::Model::ListAssetsRequest::SetFilter ( ListAssetsFilter &&  value)
inline

The filter for the requested list of assets. Choose one of the following options:

  • ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.

  • TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

Default: ALL

Definition at line 203 of file ListAssetsRequest.h.

◆ SetMaxResults()

void Aws::IoTSiteWise::Model::ListAssetsRequest::SetMaxResults ( int  value)
inline

The maximum number of results to be returned per paginated request.

Default: 50

Definition at line 99 of file ListAssetsRequest.h.

◆ SetNextToken() [1/3]

void Aws::IoTSiteWise::Model::ListAssetsRequest::SetNextToken ( const Aws::String value)
inline

The token to be used for the next set of paginated results.

Definition at line 55 of file ListAssetsRequest.h.

◆ SetNextToken() [2/3]

void Aws::IoTSiteWise::Model::ListAssetsRequest::SetNextToken ( Aws::String &&  value)
inline

The token to be used for the next set of paginated results.

Definition at line 60 of file ListAssetsRequest.h.

◆ SetNextToken() [3/3]

void Aws::IoTSiteWise::Model::ListAssetsRequest::SetNextToken ( const char *  value)
inline

The token to be used for the next set of paginated results.

Definition at line 65 of file ListAssetsRequest.h.

◆ WithAssetModelId() [1/3]

ListAssetsRequest& Aws::IoTSiteWise::Model::ListAssetsRequest::WithAssetModelId ( const Aws::String value)
inline

The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter.

Definition at line 148 of file ListAssetsRequest.h.

◆ WithAssetModelId() [2/3]

ListAssetsRequest& Aws::IoTSiteWise::Model::ListAssetsRequest::WithAssetModelId ( Aws::String &&  value)
inline

The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter.

Definition at line 155 of file ListAssetsRequest.h.

◆ WithAssetModelId() [3/3]

ListAssetsRequest& Aws::IoTSiteWise::Model::ListAssetsRequest::WithAssetModelId ( const char *  value)
inline

The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter.

Definition at line 162 of file ListAssetsRequest.h.

◆ WithFilter() [1/2]

ListAssetsRequest& Aws::IoTSiteWise::Model::ListAssetsRequest::WithFilter ( const ListAssetsFilter value)
inline

The filter for the requested list of assets. Choose one of the following options:

  • ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.

  • TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

Default: ALL

Definition at line 213 of file ListAssetsRequest.h.

◆ WithFilter() [2/2]

ListAssetsRequest& Aws::IoTSiteWise::Model::ListAssetsRequest::WithFilter ( ListAssetsFilter &&  value)
inline

The filter for the requested list of assets. Choose one of the following options:

  • ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL.

  • TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree.

Default: ALL

Definition at line 223 of file ListAssetsRequest.h.

◆ WithMaxResults()

ListAssetsRequest& Aws::IoTSiteWise::Model::ListAssetsRequest::WithMaxResults ( int  value)
inline

The maximum number of results to be returned per paginated request.

Default: 50

Definition at line 105 of file ListAssetsRequest.h.

◆ WithNextToken() [1/3]

ListAssetsRequest& Aws::IoTSiteWise::Model::ListAssetsRequest::WithNextToken ( const Aws::String value)
inline

The token to be used for the next set of paginated results.

Definition at line 70 of file ListAssetsRequest.h.

◆ WithNextToken() [2/3]

ListAssetsRequest& Aws::IoTSiteWise::Model::ListAssetsRequest::WithNextToken ( Aws::String &&  value)
inline

The token to be used for the next set of paginated results.

Definition at line 75 of file ListAssetsRequest.h.

◆ WithNextToken() [3/3]

ListAssetsRequest& Aws::IoTSiteWise::Model::ListAssetsRequest::WithNextToken ( const char *  value)
inline

The token to be used for the next set of paginated results.

Definition at line 80 of file ListAssetsRequest.h.


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