Class: Aws::IoT::Types::GetCardinalityRequest

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

Overview

Note:

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

{
  index_name: "IndexName",
  query_string: "QueryString", # required
  aggregation_field: "AggregationField",
  query_version: "QueryVersion",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aggregation_fieldString

The field to aggregate.

Returns:

  • (String)


9206
9207
9208
9209
9210
9211
9212
9213
# File 'lib/aws-sdk-iot/types.rb', line 9206

class GetCardinalityRequest < Struct.new(
  :index_name,
  :query_string,
  :aggregation_field,
  :query_version)
  SENSITIVE = []
  include Aws::Structure
end

#index_nameString

The name of the index to search.

Returns:

  • (String)


9206
9207
9208
9209
9210
9211
9212
9213
# File 'lib/aws-sdk-iot/types.rb', line 9206

class GetCardinalityRequest < Struct.new(
  :index_name,
  :query_string,
  :aggregation_field,
  :query_version)
  SENSITIVE = []
  include Aws::Structure
end

#query_stringString

The search query string.

Returns:

  • (String)


9206
9207
9208
9209
9210
9211
9212
9213
# File 'lib/aws-sdk-iot/types.rb', line 9206

class GetCardinalityRequest < Struct.new(
  :index_name,
  :query_string,
  :aggregation_field,
  :query_version)
  SENSITIVE = []
  include Aws::Structure
end

#query_versionString

The query version.

Returns:

  • (String)


9206
9207
9208
9209
9210
9211
9212
9213
# File 'lib/aws-sdk-iot/types.rb', line 9206

class GetCardinalityRequest < Struct.new(
  :index_name,
  :query_string,
  :aggregation_field,
  :query_version)
  SENSITIVE = []
  include Aws::Structure
end