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

Inherits:

Struct

• Object
• Struct
• Aws::IoTThingsGraph::Types::SearchEntitiesRequest

Defined in:

gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-iotthingsgraph/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

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

Returns:

• (Array<Types::EntityFilter>)

# File 'gems/aws-sdk-iotthingsgraph/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_results ⇒ Integer

The maximum number of results to return in the response.

Returns:

• (Integer)

# File 'gems/aws-sdk-iotthingsgraph/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_version ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-iotthingsgraph/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_token ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-iotthingsgraph/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