You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::IoTThingsGraph::Types::EntityFilter

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

Overview

Note:

When making an API call, you may pass EntityFilter data as a hash:

{
  name: "NAME", # accepts NAME, NAMESPACE, SEMANTIC_TYPE_PATH, REFERENCED_ENTITY_ID
  value: ["EntityFilterValue"],
}

An object that filters an entity search. Multiple filters function as OR criteria in the search. For example a search that includes a NAMESPACE and a REFERENCED_ENTITY_ID filter searches for entities in the specified namespace that use the entity specified by the value of REFERENCED_ENTITY_ID.

Instance Attribute Summary collapse

Instance Attribute Details

#nameString

The name of the entity search filter field. 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.

Returns:

  • (String)


534
535
536
537
538
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 534

class EntityFilter < Struct.new(
  :name,
  :value)
  include Aws::Structure
end

#valueArray<String>

An array of string values for the search filter field. Multiple values function as AND criteria in the search.

Returns:

  • (Array<String>)


534
535
536
537
538
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 534

class EntityFilter < Struct.new(
  :name,
  :value)
  include Aws::Structure
end