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

#include <ListAssetRelationshipsRequest.h>

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

Public Member Functions

 ListAssetRelationshipsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
const Aws::StringGetAssetId () const
 
bool AssetIdHasBeenSet () const
 
void SetAssetId (const Aws::String &value)
 
void SetAssetId (Aws::String &&value)
 
void SetAssetId (const char *value)
 
ListAssetRelationshipsRequestWithAssetId (const Aws::String &value)
 
ListAssetRelationshipsRequestWithAssetId (Aws::String &&value)
 
ListAssetRelationshipsRequestWithAssetId (const char *value)
 
const TraversalTypeGetTraversalType () const
 
bool TraversalTypeHasBeenSet () const
 
void SetTraversalType (const TraversalType &value)
 
void SetTraversalType (TraversalType &&value)
 
ListAssetRelationshipsRequestWithTraversalType (const TraversalType &value)
 
ListAssetRelationshipsRequestWithTraversalType (TraversalType &&value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListAssetRelationshipsRequestWithNextToken (const Aws::String &value)
 
ListAssetRelationshipsRequestWithNextToken (Aws::String &&value)
 
ListAssetRelationshipsRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListAssetRelationshipsRequestWithMaxResults (int 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 ListAssetRelationshipsRequest.h.

Constructor & Destructor Documentation

◆ ListAssetRelationshipsRequest()

Aws::IoTSiteWise::Model::ListAssetRelationshipsRequest::ListAssetRelationshipsRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

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

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

Reimplemented from Aws::AmazonWebServiceRequest.

◆ AssetIdHasBeenSet()

bool Aws::IoTSiteWise::Model::ListAssetRelationshipsRequest::AssetIdHasBeenSet ( ) const
inline

The ID of the asset.

Definition at line 50 of file ListAssetRelationshipsRequest.h.

◆ GetAssetId()

const Aws::String& Aws::IoTSiteWise::Model::ListAssetRelationshipsRequest::GetAssetId ( ) const
inline

The ID of the asset.

Definition at line 45 of file ListAssetRelationshipsRequest.h.

◆ GetMaxResults()

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

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

Definition at line 188 of file ListAssetRelationshipsRequest.h.

◆ GetNextToken()

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

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

Definition at line 147 of file ListAssetRelationshipsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file ListAssetRelationshipsRequest.h.

◆ GetTraversalType()

const TraversalType& Aws::IoTSiteWise::Model::ListAssetRelationshipsRequest::GetTraversalType ( ) const
inline

The type of traversal to use to identify asset relationships. Choose the following option:

  • PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.

Definition at line 91 of file ListAssetRelationshipsRequest.h.

◆ MaxResultsHasBeenSet()

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

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

Definition at line 193 of file ListAssetRelationshipsRequest.h.

◆ NextTokenHasBeenSet()

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

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

Definition at line 152 of file ListAssetRelationshipsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAssetId() [1/3]

void Aws::IoTSiteWise::Model::ListAssetRelationshipsRequest::SetAssetId ( Aws::String &&  value)
inline

The ID of the asset.

Definition at line 60 of file ListAssetRelationshipsRequest.h.

◆ SetAssetId() [2/3]

void Aws::IoTSiteWise::Model::ListAssetRelationshipsRequest::SetAssetId ( const Aws::String value)
inline

The ID of the asset.

Definition at line 55 of file ListAssetRelationshipsRequest.h.

◆ SetAssetId() [3/3]

void Aws::IoTSiteWise::Model::ListAssetRelationshipsRequest::SetAssetId ( const char *  value)
inline

The ID of the asset.

Definition at line 65 of file ListAssetRelationshipsRequest.h.

◆ SetMaxResults()

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

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

Definition at line 198 of file ListAssetRelationshipsRequest.h.

◆ SetNextToken() [1/3]

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

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

Definition at line 162 of file ListAssetRelationshipsRequest.h.

◆ SetNextToken() [2/3]

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

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

Definition at line 157 of file ListAssetRelationshipsRequest.h.

◆ SetNextToken() [3/3]

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

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

Definition at line 167 of file ListAssetRelationshipsRequest.h.

◆ SetTraversalType() [1/2]

void Aws::IoTSiteWise::Model::ListAssetRelationshipsRequest::SetTraversalType ( const TraversalType value)
inline

The type of traversal to use to identify asset relationships. Choose the following option:

  • PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.

Definition at line 111 of file ListAssetRelationshipsRequest.h.

◆ SetTraversalType() [2/2]

void Aws::IoTSiteWise::Model::ListAssetRelationshipsRequest::SetTraversalType ( TraversalType &&  value)
inline

The type of traversal to use to identify asset relationships. Choose the following option:

  • PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.

Definition at line 121 of file ListAssetRelationshipsRequest.h.

◆ TraversalTypeHasBeenSet()

bool Aws::IoTSiteWise::Model::ListAssetRelationshipsRequest::TraversalTypeHasBeenSet ( ) const
inline

The type of traversal to use to identify asset relationships. Choose the following option:

  • PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.

Definition at line 101 of file ListAssetRelationshipsRequest.h.

◆ WithAssetId() [1/3]

ListAssetRelationshipsRequest& Aws::IoTSiteWise::Model::ListAssetRelationshipsRequest::WithAssetId ( Aws::String &&  value)
inline

The ID of the asset.

Definition at line 75 of file ListAssetRelationshipsRequest.h.

◆ WithAssetId() [2/3]

ListAssetRelationshipsRequest& Aws::IoTSiteWise::Model::ListAssetRelationshipsRequest::WithAssetId ( const Aws::String value)
inline

The ID of the asset.

Definition at line 70 of file ListAssetRelationshipsRequest.h.

◆ WithAssetId() [3/3]

ListAssetRelationshipsRequest& Aws::IoTSiteWise::Model::ListAssetRelationshipsRequest::WithAssetId ( const char *  value)
inline

The ID of the asset.

Definition at line 80 of file ListAssetRelationshipsRequest.h.

◆ WithMaxResults()

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

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

Definition at line 203 of file ListAssetRelationshipsRequest.h.

◆ WithNextToken() [1/3]

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

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

Definition at line 177 of file ListAssetRelationshipsRequest.h.

◆ WithNextToken() [2/3]

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

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

Definition at line 172 of file ListAssetRelationshipsRequest.h.

◆ WithNextToken() [3/3]

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

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

Definition at line 182 of file ListAssetRelationshipsRequest.h.

◆ WithTraversalType() [1/2]

ListAssetRelationshipsRequest& Aws::IoTSiteWise::Model::ListAssetRelationshipsRequest::WithTraversalType ( const TraversalType value)
inline

The type of traversal to use to identify asset relationships. Choose the following option:

  • PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.

Definition at line 131 of file ListAssetRelationshipsRequest.h.

◆ WithTraversalType() [2/2]

ListAssetRelationshipsRequest& Aws::IoTSiteWise::Model::ListAssetRelationshipsRequest::WithTraversalType ( TraversalType &&  value)
inline

The type of traversal to use to identify asset relationships. Choose the following option:

  • PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result.

Definition at line 141 of file ListAssetRelationshipsRequest.h.


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