Class: Aws::IoTThingsGraph::Types::SearchEntitiesRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iotthingsgraph/types.rb

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#entity_typesArray<String>

The entity types for which to search.

Returns:

  • (Array<String>)


1028
1029
1030
1031
1032
1033
1034
1035
1036
# File 'lib/aws-sdk-iotthingsgraph/types.rb', line 1028

class SearchEntitiesRequest < Struct.new(
  :entity_types,
  :filters,
  :next_token,
  :max_results,
  :namespace_version)
  SENSITIVE = []
  include Aws::Structure
end

#filtersArray<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.

Returns:



1028
1029
1030
1031
1032
1033
1034
1035
1036
# File 'lib/aws-sdk-iotthingsgraph/types.rb', line 1028

class SearchEntitiesRequest < Struct.new(
  :entity_types,
  :filters,
  :next_token,
  :max_results,
  :namespace_version)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return in the response.

Returns:

  • (Integer)


1028
1029
1030
1031
1032
1033
1034
1035
1036
# File 'lib/aws-sdk-iotthingsgraph/types.rb', line 1028

class SearchEntitiesRequest < Struct.new(
  :entity_types,
  :filters,
  :next_token,
  :max_results,
  :namespace_version)
  SENSITIVE = []
  include Aws::Structure
end

#namespace_versionInteger

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

Returns:

  • (Integer)


1028
1029
1030
1031
1032
1033
1034
1035
1036
# File 'lib/aws-sdk-iotthingsgraph/types.rb', line 1028

class SearchEntitiesRequest < Struct.new(
  :entity_types,
  :filters,
  :next_token,
  :max_results,
  :namespace_version)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


1028
1029
1030
1031
1032
1033
1034
1035
1036
# File 'lib/aws-sdk-iotthingsgraph/types.rb', line 1028

class SearchEntitiesRequest < Struct.new(
  :entity_types,
  :filters,
  :next_token,
  :max_results,
  :namespace_version)
  SENSITIVE = []
  include Aws::Structure
end