You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::IoTThingsGraph::Types::SearchEntitiesRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoTThingsGraph::Types::SearchEntitiesRequest
- Defined in:
- (unknown)
Overview
When passing SearchEntitiesRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
entity_types: ["DEVICE"], # required, accepts DEVICE, SERVICE, DEVICE_MODEL, CAPABILITY, STATE, ACTION, EVENT, PROPERTY, MAPPING, ENUM
filters: [
{
name: "NAME", # accepts NAME, NAMESPACE, SEMANTIC_TYPE_PATH, REFERENCED_ENTITY_ID
value: ["EntityFilterValue"],
},
],
next_token: "NextToken",
max_results: 1,
namespace_version: 1,
}
Instance Attribute Summary collapse
-
#entity_types ⇒ Array<String>
The entity types for which to search.
-
#filters ⇒ Array<Types::EntityFilter>
Optional filter to apply to the search.
-
#max_results ⇒ Integer
The maximum number of results to return in the response.
-
#namespace_version ⇒ Integer
The version of the user\'s namespace.
-
#next_token ⇒ String
The string that specifies the next page of results.
Instance Attribute Details
#entity_types ⇒ Array<String>
The entity types for which to search.
#filters ⇒ Array<Types::EntityFilter>
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.
#max_results ⇒ Integer
The maximum number of results to return in the response.
#namespace_version ⇒ Integer
The version of the user\'s namespace. Defaults to the latest version of the user\'s namespace.
#next_token ⇒ String
The string that specifies the next page of results. Use this when you\'re paginating results.