Class: Aws::IoTSiteWise::Types::SearchResult

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::SearchResult

Defined in:

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

Overview

A single matching segment of time-series data returned by a search.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dataset_id ⇒ String

  The identifier of the dataset that contains the matching data.

• #end_timestamp ⇒ Types::TimeInNanos

  The end of the matching time-series segment, in nanoseconds since the Unix epoch.

• #score ⇒ Float

  The relevance score of this result.

• #search_id ⇒ String

  The identifier of the search that produced this result.

• #start_timestamp ⇒ Types::TimeInNanos

  The start of the matching time-series segment, in nanoseconds since the Unix epoch.

• #time_series_id ⇒ String

  The identifier of the time series that contains the matching data.

• #top_timestamp ⇒ Types::TimeInNanos

  The timestamp of the most relevant point within the matching segment, in nanoseconds since the Unix epoch.

• #workspace_name ⇒ String

  The name of the workspace the search ran against.

Instance Attribute Details

#dataset_id ⇒ String

The identifier of the dataset that contains the matching data.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 13451

class SearchResult < Struct.new(
  :search_id,
  :workspace_name,
  :dataset_id,
  :time_series_id,
  :start_timestamp,
  :end_timestamp,
  :top_timestamp,
  :score)
  SENSITIVE = []
  include Aws::Structure
end

#end_timestamp ⇒ Types::TimeInNanos

The end of the matching time-series segment, in nanoseconds since the Unix epoch.

Returns:

• (Types::TimeInNanos)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 13451

class SearchResult < Struct.new(
  :search_id,
  :workspace_name,
  :dataset_id,
  :time_series_id,
  :start_timestamp,
  :end_timestamp,
  :top_timestamp,
  :score)
  SENSITIVE = []
  include Aws::Structure
end

#score ⇒ Float

The relevance score of this result. Higher scores indicate a stronger match.

Returns:

• (Float)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 13451

class SearchResult < Struct.new(
  :search_id,
  :workspace_name,
  :dataset_id,
  :time_series_id,
  :start_timestamp,
  :end_timestamp,
  :top_timestamp,
  :score)
  SENSITIVE = []
  include Aws::Structure
end

#search_id ⇒ String

The identifier of the search that produced this result.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 13451

class SearchResult < Struct.new(
  :search_id,
  :workspace_name,
  :dataset_id,
  :time_series_id,
  :start_timestamp,
  :end_timestamp,
  :top_timestamp,
  :score)
  SENSITIVE = []
  include Aws::Structure
end

#start_timestamp ⇒ Types::TimeInNanos

The start of the matching time-series segment, in nanoseconds since the Unix epoch.

Returns:

• (Types::TimeInNanos)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 13451

class SearchResult < Struct.new(
  :search_id,
  :workspace_name,
  :dataset_id,
  :time_series_id,
  :start_timestamp,
  :end_timestamp,
  :top_timestamp,
  :score)
  SENSITIVE = []
  include Aws::Structure
end

#time_series_id ⇒ String

The identifier of the time series that contains the matching data.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 13451

class SearchResult < Struct.new(
  :search_id,
  :workspace_name,
  :dataset_id,
  :time_series_id,
  :start_timestamp,
  :end_timestamp,
  :top_timestamp,
  :score)
  SENSITIVE = []
  include Aws::Structure
end

#top_timestamp ⇒ Types::TimeInNanos

The timestamp of the most relevant point within the matching segment, in nanoseconds since the Unix epoch.

Returns:

• (Types::TimeInNanos)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 13451

class SearchResult < Struct.new(
  :search_id,
  :workspace_name,
  :dataset_id,
  :time_series_id,
  :start_timestamp,
  :end_timestamp,
  :top_timestamp,
  :score)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_name ⇒ String

The name of the workspace the search ran against.

Returns:

• (String)

# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 13451

class SearchResult < Struct.new(
  :search_id,
  :workspace_name,
  :dataset_id,
  :time_series_id,
  :start_timestamp,
  :end_timestamp,
  :top_timestamp,
  :score)
  SENSITIVE = []
  include Aws::Structure
end