Class: Aws::IoT::Types::GetPercentilesRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::GetPercentilesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

Note:

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

{
  index_name: "IndexName",
  query_string: "QueryString", # required
  aggregation_field: "AggregationField",
  query_version: "QueryVersion",
  percents: [1.0],
}

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #aggregation_field ⇒ String

  The field to aggregate.

• #index_name ⇒ String

  The name of the index to search.

• #percents ⇒ Array<Float>

  The percentile groups returned.

• #query_string ⇒ String

  The search query string.

• #query_version ⇒ String

  The query version.

Instance Attribute Details

#aggregation_field ⇒ String

The field to aggregate.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 9325

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

#index_name ⇒ String

The name of the index to search.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 9325

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

#percents ⇒ Array<Float>

The percentile groups returned.

Returns:

• (Array<Float>)

# File 'lib/aws-sdk-iot/types.rb', line 9325

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

#query_string ⇒ String

The search query string.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 9325

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

#query_version ⇒ String

The query version.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 9325

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