AWS SDK for C++  1.9.19
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoTThingsGraph::Model::GetEntitiesRequest Class Reference

#include <GetEntitiesRequest.h>

+ Inheritance diagram for Aws::IoTThingsGraph::Model::GetEntitiesRequest:

Public Member Functions

 GetEntitiesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::Vector< Aws::String > & GetIds () const
 
bool IdsHasBeenSet () const
 
void SetIds (const Aws::Vector< Aws::String > &value)
 
void SetIds (Aws::Vector< Aws::String > &&value)
 
GetEntitiesRequestWithIds (const Aws::Vector< Aws::String > &value)
 
GetEntitiesRequestWithIds (Aws::Vector< Aws::String > &&value)
 
GetEntitiesRequestAddIds (const Aws::String &value)
 
GetEntitiesRequestAddIds (Aws::String &&value)
 
GetEntitiesRequestAddIds (const char *value)
 
long long GetNamespaceVersion () const
 
bool NamespaceVersionHasBeenSet () const
 
void SetNamespaceVersion (long long value)
 
GetEntitiesRequestWithNamespaceVersion (long long value)
 
- Public Member Functions inherited from Aws::IoTThingsGraph::IoTThingsGraphRequest
virtual ~IoTThingsGraphRequest ()
 
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 AddQueryStringParameters (Aws::Http::URI &uri) const
 
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::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 22 of file GetEntitiesRequest.h.

Constructor & Destructor Documentation

◆ GetEntitiesRequest()

Aws::IoTThingsGraph::Model::GetEntitiesRequest::GetEntitiesRequest ( )

Member Function Documentation

◆ AddIds() [1/3]

GetEntitiesRequest& Aws::IoTThingsGraph::Model::GetEntitiesRequest::AddIds ( Aws::String &&  value)
inline

An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

Definition at line 84 of file GetEntitiesRequest.h.

◆ AddIds() [2/3]

GetEntitiesRequest& Aws::IoTThingsGraph::Model::GetEntitiesRequest::AddIds ( const Aws::String value)
inline

An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

Definition at line 78 of file GetEntitiesRequest.h.

◆ AddIds() [3/3]

GetEntitiesRequest& Aws::IoTThingsGraph::Model::GetEntitiesRequest::AddIds ( const char *  value)
inline

An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

Definition at line 90 of file GetEntitiesRequest.h.

◆ GetIds()

const Aws::Vector<Aws::String>& Aws::IoTThingsGraph::Model::GetEntitiesRequest::GetIds ( ) const
inline

An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

Definition at line 42 of file GetEntitiesRequest.h.

◆ GetNamespaceVersion()

long long Aws::IoTThingsGraph::Model::GetEntitiesRequest::GetNamespaceVersion ( ) const
inline

The version of the user's namespace. Defaults to the latest version of the user's namespace.

Definition at line 97 of file GetEntitiesRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::IoTThingsGraph::Model::GetEntitiesRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::IoTThingsGraph::Model::GetEntitiesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file GetEntitiesRequest.h.

◆ IdsHasBeenSet()

bool Aws::IoTThingsGraph::Model::GetEntitiesRequest::IdsHasBeenSet ( ) const
inline

An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

Definition at line 48 of file GetEntitiesRequest.h.

◆ NamespaceVersionHasBeenSet()

bool Aws::IoTThingsGraph::Model::GetEntitiesRequest::NamespaceVersionHasBeenSet ( ) const
inline

The version of the user's namespace. Defaults to the latest version of the user's namespace.

Definition at line 103 of file GetEntitiesRequest.h.

◆ SerializePayload()

Aws::String Aws::IoTThingsGraph::Model::GetEntitiesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetIds() [1/2]

void Aws::IoTThingsGraph::Model::GetEntitiesRequest::SetIds ( Aws::Vector< Aws::String > &&  value)
inline

An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

Definition at line 60 of file GetEntitiesRequest.h.

◆ SetIds() [2/2]

void Aws::IoTThingsGraph::Model::GetEntitiesRequest::SetIds ( const Aws::Vector< Aws::String > &  value)
inline

An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

Definition at line 54 of file GetEntitiesRequest.h.

◆ SetNamespaceVersion()

void Aws::IoTThingsGraph::Model::GetEntitiesRequest::SetNamespaceVersion ( long long  value)
inline

The version of the user's namespace. Defaults to the latest version of the user's namespace.

Definition at line 109 of file GetEntitiesRequest.h.

◆ WithIds() [1/2]

GetEntitiesRequest& Aws::IoTThingsGraph::Model::GetEntitiesRequest::WithIds ( Aws::Vector< Aws::String > &&  value)
inline

An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

Definition at line 72 of file GetEntitiesRequest.h.

◆ WithIds() [2/2]

GetEntitiesRequest& Aws::IoTThingsGraph::Model::GetEntitiesRequest::WithIds ( const Aws::Vector< Aws::String > &  value)
inline

An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

Definition at line 66 of file GetEntitiesRequest.h.

◆ WithNamespaceVersion()

GetEntitiesRequest& Aws::IoTThingsGraph::Model::GetEntitiesRequest::WithNamespaceVersion ( long long  value)
inline

The version of the user's namespace. Defaults to the latest version of the user's namespace.

Definition at line 115 of file GetEntitiesRequest.h.


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