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

#include <ListAssociatedAssetsRequest.h>

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

Public Member Functions

 ListAssociatedAssetsRequest ()
 
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)
 
ListAssociatedAssetsRequestWithAssetId (const Aws::String &value)
 
ListAssociatedAssetsRequestWithAssetId (Aws::String &&value)
 
ListAssociatedAssetsRequestWithAssetId (const char *value)
 
const Aws::StringGetHierarchyId () const
 
bool HierarchyIdHasBeenSet () const
 
void SetHierarchyId (const Aws::String &value)
 
void SetHierarchyId (Aws::String &&value)
 
void SetHierarchyId (const char *value)
 
ListAssociatedAssetsRequestWithHierarchyId (const Aws::String &value)
 
ListAssociatedAssetsRequestWithHierarchyId (Aws::String &&value)
 
ListAssociatedAssetsRequestWithHierarchyId (const char *value)
 
const TraversalDirectionGetTraversalDirection () const
 
bool TraversalDirectionHasBeenSet () const
 
void SetTraversalDirection (const TraversalDirection &value)
 
void SetTraversalDirection (TraversalDirection &&value)
 
ListAssociatedAssetsRequestWithTraversalDirection (const TraversalDirection &value)
 
ListAssociatedAssetsRequestWithTraversalDirection (TraversalDirection &&value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListAssociatedAssetsRequestWithNextToken (const Aws::String &value)
 
ListAssociatedAssetsRequestWithNextToken (Aws::String &&value)
 
ListAssociatedAssetsRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListAssociatedAssetsRequestWithMaxResults (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 ListAssociatedAssetsRequest.h.

Constructor & Destructor Documentation

◆ ListAssociatedAssetsRequest()

Aws::IoTSiteWise::Model::ListAssociatedAssetsRequest::ListAssociatedAssetsRequest ( )

Member Function Documentation

◆ AddQueryStringParameters()

void Aws::IoTSiteWise::Model::ListAssociatedAssetsRequest::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::ListAssociatedAssetsRequest::AssetIdHasBeenSet ( ) const
inline

The ID of the asset to query.

Definition at line 50 of file ListAssociatedAssetsRequest.h.

◆ GetAssetId()

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

The ID of the asset to query.

Definition at line 45 of file ListAssociatedAssetsRequest.h.

◆ GetHierarchyId()

const Aws::String& Aws::IoTSiteWise::Model::ListAssociatedAssetsRequest::GetHierarchyId ( ) const
inline

The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection.

For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

Definition at line 94 of file ListAssociatedAssetsRequest.h.

◆ GetMaxResults()

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

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

Default: 50

Definition at line 294 of file ListAssociatedAssetsRequest.h.

◆ GetNextToken()

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

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

Definition at line 252 of file ListAssociatedAssetsRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file ListAssociatedAssetsRequest.h.

◆ GetTraversalDirection()

const TraversalDirection& Aws::IoTSiteWise::Model::ListAssociatedAssetsRequest::GetTraversalDirection ( ) const
inline

The direction to list associated assets. Choose one of the following options:

  • CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD.

  • PARENT – The list includes the asset's parent asset.

Default: CHILD

Definition at line 196 of file ListAssociatedAssetsRequest.h.

◆ HierarchyIdHasBeenSet()

bool Aws::IoTSiteWise::Model::ListAssociatedAssetsRequest::HierarchyIdHasBeenSet ( ) const
inline

The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection.

For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

Definition at line 107 of file ListAssociatedAssetsRequest.h.

◆ MaxResultsHasBeenSet()

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

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

Default: 50

Definition at line 300 of file ListAssociatedAssetsRequest.h.

◆ NextTokenHasBeenSet()

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

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

Definition at line 257 of file ListAssociatedAssetsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAssetId() [1/3]

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

The ID of the asset to query.

Definition at line 55 of file ListAssociatedAssetsRequest.h.

◆ SetAssetId() [2/3]

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

The ID of the asset to query.

Definition at line 60 of file ListAssociatedAssetsRequest.h.

◆ SetAssetId() [3/3]

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

The ID of the asset to query.

Definition at line 65 of file ListAssociatedAssetsRequest.h.

◆ SetHierarchyId() [1/3]

void Aws::IoTSiteWise::Model::ListAssociatedAssetsRequest::SetHierarchyId ( const Aws::String value)
inline

The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection.

For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

Definition at line 120 of file ListAssociatedAssetsRequest.h.

◆ SetHierarchyId() [2/3]

void Aws::IoTSiteWise::Model::ListAssociatedAssetsRequest::SetHierarchyId ( Aws::String &&  value)
inline

The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection.

For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

Definition at line 133 of file ListAssociatedAssetsRequest.h.

◆ SetHierarchyId() [3/3]

void Aws::IoTSiteWise::Model::ListAssociatedAssetsRequest::SetHierarchyId ( const char *  value)
inline

The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection.

For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

Definition at line 146 of file ListAssociatedAssetsRequest.h.

◆ SetMaxResults()

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

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

Default: 50

Definition at line 306 of file ListAssociatedAssetsRequest.h.

◆ SetNextToken() [1/3]

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

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

Definition at line 262 of file ListAssociatedAssetsRequest.h.

◆ SetNextToken() [2/3]

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

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

Definition at line 267 of file ListAssociatedAssetsRequest.h.

◆ SetNextToken() [3/3]

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

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

Definition at line 272 of file ListAssociatedAssetsRequest.h.

◆ SetTraversalDirection() [1/2]

void Aws::IoTSiteWise::Model::ListAssociatedAssetsRequest::SetTraversalDirection ( const TraversalDirection value)
inline

The direction to list associated assets. Choose one of the following options:

  • CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD.

  • PARENT – The list includes the asset's parent asset.

Default: CHILD

Definition at line 216 of file ListAssociatedAssetsRequest.h.

◆ SetTraversalDirection() [2/2]

void Aws::IoTSiteWise::Model::ListAssociatedAssetsRequest::SetTraversalDirection ( TraversalDirection &&  value)
inline

The direction to list associated assets. Choose one of the following options:

  • CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD.

  • PARENT – The list includes the asset's parent asset.

Default: CHILD

Definition at line 226 of file ListAssociatedAssetsRequest.h.

◆ TraversalDirectionHasBeenSet()

bool Aws::IoTSiteWise::Model::ListAssociatedAssetsRequest::TraversalDirectionHasBeenSet ( ) const
inline

The direction to list associated assets. Choose one of the following options:

  • CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD.

  • PARENT – The list includes the asset's parent asset.

Default: CHILD

Definition at line 206 of file ListAssociatedAssetsRequest.h.

◆ WithAssetId() [1/3]

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

The ID of the asset to query.

Definition at line 70 of file ListAssociatedAssetsRequest.h.

◆ WithAssetId() [2/3]

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

The ID of the asset to query.

Definition at line 75 of file ListAssociatedAssetsRequest.h.

◆ WithAssetId() [3/3]

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

The ID of the asset to query.

Definition at line 80 of file ListAssociatedAssetsRequest.h.

◆ WithHierarchyId() [1/3]

ListAssociatedAssetsRequest& Aws::IoTSiteWise::Model::ListAssociatedAssetsRequest::WithHierarchyId ( const Aws::String value)
inline

The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection.

For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

Definition at line 159 of file ListAssociatedAssetsRequest.h.

◆ WithHierarchyId() [2/3]

ListAssociatedAssetsRequest& Aws::IoTSiteWise::Model::ListAssociatedAssetsRequest::WithHierarchyId ( Aws::String &&  value)
inline

The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection.

For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

Definition at line 172 of file ListAssociatedAssetsRequest.h.

◆ WithHierarchyId() [3/3]

ListAssociatedAssetsRequest& Aws::IoTSiteWise::Model::ListAssociatedAssetsRequest::WithHierarchyId ( const char *  value)
inline

The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection.

For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide.

Definition at line 185 of file ListAssociatedAssetsRequest.h.

◆ WithMaxResults()

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

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

Default: 50

Definition at line 312 of file ListAssociatedAssetsRequest.h.

◆ WithNextToken() [1/3]

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

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

Definition at line 277 of file ListAssociatedAssetsRequest.h.

◆ WithNextToken() [2/3]

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

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

Definition at line 282 of file ListAssociatedAssetsRequest.h.

◆ WithNextToken() [3/3]

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

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

Definition at line 287 of file ListAssociatedAssetsRequest.h.

◆ WithTraversalDirection() [1/2]

ListAssociatedAssetsRequest& Aws::IoTSiteWise::Model::ListAssociatedAssetsRequest::WithTraversalDirection ( const TraversalDirection value)
inline

The direction to list associated assets. Choose one of the following options:

  • CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD.

  • PARENT – The list includes the asset's parent asset.

Default: CHILD

Definition at line 236 of file ListAssociatedAssetsRequest.h.

◆ WithTraversalDirection() [2/2]

ListAssociatedAssetsRequest& Aws::IoTSiteWise::Model::ListAssociatedAssetsRequest::WithTraversalDirection ( TraversalDirection &&  value)
inline

The direction to list associated assets. Choose one of the following options:

  • CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD.

  • PARENT – The list includes the asset's parent asset.

Default: CHILD

Definition at line 246 of file ListAssociatedAssetsRequest.h.


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