Class: Aws::IoTSiteWise::Types::DescribeQueryResponse

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::DescribeQueryResponse

Defined in:

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

Overview

Contains the response for the DescribeQuery operation.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #completed_at ⇒ Time

  The date and time when the query reached a terminal state, in Unix epoch time.

• #error_message ⇒ String

  A human-readable error description.

• #query_id ⇒ String

  The unique identifier for the query execution.

• #statistics ⇒ Types::QueryStatistics

  The query execution statistics.

• #status ⇒ String

  The current query status.

• #submitted_at ⇒ Time

  The date and time when the query was submitted, in Unix epoch time.

Instance Attribute Details

#completed_at ⇒ Time

The date and time when the query reached a terminal state, in Unix epoch time. This field is present when the query status is COMPLETED, FAILED, or CANCELED.

Returns:

• (Time)

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

class DescribeQueryResponse < Struct.new(
  :query_id,
  :status,
  :submitted_at,
  :completed_at,
  :statistics,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#error_message ⇒ String

A human-readable error description. This field is present when the query status is FAILED.

Returns:

• (String)

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

class DescribeQueryResponse < Struct.new(
  :query_id,
  :status,
  :submitted_at,
  :completed_at,
  :statistics,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#query_id ⇒ String

The unique identifier for the query execution.

Returns:

• (String)

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

class DescribeQueryResponse < Struct.new(
  :query_id,
  :status,
  :submitted_at,
  :completed_at,
  :statistics,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#statistics ⇒ Types::QueryStatistics

The query execution statistics. This field is present when the query status is COMPLETED.

Returns:

• (Types::QueryStatistics)

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

class DescribeQueryResponse < Struct.new(
  :query_id,
  :status,
  :submitted_at,
  :completed_at,
  :statistics,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current query status.

Returns:

• (String)

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

class DescribeQueryResponse < Struct.new(
  :query_id,
  :status,
  :submitted_at,
  :completed_at,
  :statistics,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#submitted_at ⇒ Time

The date and time when the query was submitted, in Unix epoch time.

Returns:

• (Time)

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

class DescribeQueryResponse < Struct.new(
  :query_id,
  :status,
  :submitted_at,
  :completed_at,
  :statistics,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end