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

#include <SearchEntitiesRequest.h>

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

Public Member Functions

 SearchEntitiesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::Vector< EntityType > & GetEntityTypes () const
 
bool EntityTypesHasBeenSet () const
 
void SetEntityTypes (const Aws::Vector< EntityType > &value)
 
void SetEntityTypes (Aws::Vector< EntityType > &&value)
 
SearchEntitiesRequestWithEntityTypes (const Aws::Vector< EntityType > &value)
 
SearchEntitiesRequestWithEntityTypes (Aws::Vector< EntityType > &&value)
 
SearchEntitiesRequestAddEntityTypes (const EntityType &value)
 
SearchEntitiesRequestAddEntityTypes (EntityType &&value)
 
const Aws::Vector< EntityFilter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< EntityFilter > &value)
 
void SetFilters (Aws::Vector< EntityFilter > &&value)
 
SearchEntitiesRequestWithFilters (const Aws::Vector< EntityFilter > &value)
 
SearchEntitiesRequestWithFilters (Aws::Vector< EntityFilter > &&value)
 
SearchEntitiesRequestAddFilters (const EntityFilter &value)
 
SearchEntitiesRequestAddFilters (EntityFilter &&value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
SearchEntitiesRequestWithNextToken (const Aws::String &value)
 
SearchEntitiesRequestWithNextToken (Aws::String &&value)
 
SearchEntitiesRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
SearchEntitiesRequestWithMaxResults (int value)
 
long long GetNamespaceVersion () const
 
bool NamespaceVersionHasBeenSet () const
 
void SetNamespaceVersion (long long value)
 
SearchEntitiesRequestWithNamespaceVersion (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 24 of file SearchEntitiesRequest.h.

Constructor & Destructor Documentation

◆ SearchEntitiesRequest()

Aws::IoTThingsGraph::Model::SearchEntitiesRequest::SearchEntitiesRequest ( )

Member Function Documentation

◆ AddEntityTypes() [1/2]

SearchEntitiesRequest& Aws::IoTThingsGraph::Model::SearchEntitiesRequest::AddEntityTypes ( const EntityType value)
inline

The entity types for which to search.

Definition at line 73 of file SearchEntitiesRequest.h.

◆ AddEntityTypes() [2/2]

SearchEntitiesRequest& Aws::IoTThingsGraph::Model::SearchEntitiesRequest::AddEntityTypes ( EntityType &&  value)
inline

The entity types for which to search.

Definition at line 78 of file SearchEntitiesRequest.h.

◆ AddFilters() [1/2]

SearchEntitiesRequest& Aws::IoTThingsGraph::Model::SearchEntitiesRequest::AddFilters ( const EntityFilter value)
inline

Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

Definition at line 156 of file SearchEntitiesRequest.h.

◆ AddFilters() [2/2]

SearchEntitiesRequest& Aws::IoTThingsGraph::Model::SearchEntitiesRequest::AddFilters ( EntityFilter &&  value)
inline

Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

Definition at line 167 of file SearchEntitiesRequest.h.

◆ EntityTypesHasBeenSet()

bool Aws::IoTThingsGraph::Model::SearchEntitiesRequest::EntityTypesHasBeenSet ( ) const
inline

The entity types for which to search.

Definition at line 48 of file SearchEntitiesRequest.h.

◆ FiltersHasBeenSet()

bool Aws::IoTThingsGraph::Model::SearchEntitiesRequest::FiltersHasBeenSet ( ) const
inline

Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

Definition at line 101 of file SearchEntitiesRequest.h.

◆ GetEntityTypes()

const Aws::Vector<EntityType>& Aws::IoTThingsGraph::Model::SearchEntitiesRequest::GetEntityTypes ( ) const
inline

The entity types for which to search.

Definition at line 43 of file SearchEntitiesRequest.h.

◆ GetFilters()

const Aws::Vector<EntityFilter>& Aws::IoTThingsGraph::Model::SearchEntitiesRequest::GetFilters ( ) const
inline

Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

Definition at line 90 of file SearchEntitiesRequest.h.

◆ GetMaxResults()

int Aws::IoTThingsGraph::Model::SearchEntitiesRequest::GetMaxResults ( ) const
inline

The maximum number of results to return in the response.

Definition at line 222 of file SearchEntitiesRequest.h.

◆ GetNamespaceVersion()

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

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

Definition at line 244 of file SearchEntitiesRequest.h.

◆ GetNextToken()

const Aws::String& Aws::IoTThingsGraph::Model::SearchEntitiesRequest::GetNextToken ( ) const
inline

The string that specifies the next page of results. Use this when you're paginating results.

Definition at line 174 of file SearchEntitiesRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file SearchEntitiesRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::IoTThingsGraph::Model::SearchEntitiesRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of results to return in the response.

Definition at line 227 of file SearchEntitiesRequest.h.

◆ NamespaceVersionHasBeenSet()

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

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

Definition at line 250 of file SearchEntitiesRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::IoTThingsGraph::Model::SearchEntitiesRequest::NextTokenHasBeenSet ( ) const
inline

The string that specifies the next page of results. Use this when you're paginating results.

Definition at line 180 of file SearchEntitiesRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEntityTypes() [1/2]

void Aws::IoTThingsGraph::Model::SearchEntitiesRequest::SetEntityTypes ( const Aws::Vector< EntityType > &  value)
inline

The entity types for which to search.

Definition at line 53 of file SearchEntitiesRequest.h.

◆ SetEntityTypes() [2/2]

void Aws::IoTThingsGraph::Model::SearchEntitiesRequest::SetEntityTypes ( Aws::Vector< EntityType > &&  value)
inline

The entity types for which to search.

Definition at line 58 of file SearchEntitiesRequest.h.

◆ SetFilters() [1/2]

void Aws::IoTThingsGraph::Model::SearchEntitiesRequest::SetFilters ( const Aws::Vector< EntityFilter > &  value)
inline

Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

Definition at line 112 of file SearchEntitiesRequest.h.

◆ SetFilters() [2/2]

void Aws::IoTThingsGraph::Model::SearchEntitiesRequest::SetFilters ( Aws::Vector< EntityFilter > &&  value)
inline

Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

Definition at line 123 of file SearchEntitiesRequest.h.

◆ SetMaxResults()

void Aws::IoTThingsGraph::Model::SearchEntitiesRequest::SetMaxResults ( int  value)
inline

The maximum number of results to return in the response.

Definition at line 232 of file SearchEntitiesRequest.h.

◆ SetNamespaceVersion()

void Aws::IoTThingsGraph::Model::SearchEntitiesRequest::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 256 of file SearchEntitiesRequest.h.

◆ SetNextToken() [1/3]

void Aws::IoTThingsGraph::Model::SearchEntitiesRequest::SetNextToken ( const Aws::String value)
inline

The string that specifies the next page of results. Use this when you're paginating results.

Definition at line 186 of file SearchEntitiesRequest.h.

◆ SetNextToken() [2/3]

void Aws::IoTThingsGraph::Model::SearchEntitiesRequest::SetNextToken ( Aws::String &&  value)
inline

The string that specifies the next page of results. Use this when you're paginating results.

Definition at line 192 of file SearchEntitiesRequest.h.

◆ SetNextToken() [3/3]

void Aws::IoTThingsGraph::Model::SearchEntitiesRequest::SetNextToken ( const char *  value)
inline

The string that specifies the next page of results. Use this when you're paginating results.

Definition at line 198 of file SearchEntitiesRequest.h.

◆ WithEntityTypes() [1/2]

SearchEntitiesRequest& Aws::IoTThingsGraph::Model::SearchEntitiesRequest::WithEntityTypes ( const Aws::Vector< EntityType > &  value)
inline

The entity types for which to search.

Definition at line 63 of file SearchEntitiesRequest.h.

◆ WithEntityTypes() [2/2]

SearchEntitiesRequest& Aws::IoTThingsGraph::Model::SearchEntitiesRequest::WithEntityTypes ( Aws::Vector< EntityType > &&  value)
inline

The entity types for which to search.

Definition at line 68 of file SearchEntitiesRequest.h.

◆ WithFilters() [1/2]

SearchEntitiesRequest& Aws::IoTThingsGraph::Model::SearchEntitiesRequest::WithFilters ( const Aws::Vector< EntityFilter > &  value)
inline

Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

Definition at line 134 of file SearchEntitiesRequest.h.

◆ WithFilters() [2/2]

SearchEntitiesRequest& Aws::IoTThingsGraph::Model::SearchEntitiesRequest::WithFilters ( Aws::Vector< EntityFilter > &&  value)
inline

Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

Definition at line 145 of file SearchEntitiesRequest.h.

◆ WithMaxResults()

SearchEntitiesRequest& Aws::IoTThingsGraph::Model::SearchEntitiesRequest::WithMaxResults ( int  value)
inline

The maximum number of results to return in the response.

Definition at line 237 of file SearchEntitiesRequest.h.

◆ WithNamespaceVersion()

SearchEntitiesRequest& Aws::IoTThingsGraph::Model::SearchEntitiesRequest::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 262 of file SearchEntitiesRequest.h.

◆ WithNextToken() [1/3]

SearchEntitiesRequest& Aws::IoTThingsGraph::Model::SearchEntitiesRequest::WithNextToken ( const Aws::String value)
inline

The string that specifies the next page of results. Use this when you're paginating results.

Definition at line 204 of file SearchEntitiesRequest.h.

◆ WithNextToken() [2/3]

SearchEntitiesRequest& Aws::IoTThingsGraph::Model::SearchEntitiesRequest::WithNextToken ( Aws::String &&  value)
inline

The string that specifies the next page of results. Use this when you're paginating results.

Definition at line 210 of file SearchEntitiesRequest.h.

◆ WithNextToken() [3/3]

SearchEntitiesRequest& Aws::IoTThingsGraph::Model::SearchEntitiesRequest::WithNextToken ( const char *  value)
inline

The string that specifies the next page of results. Use this when you're paginating results.

Definition at line 216 of file SearchEntitiesRequest.h.


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