Class: Aws::IoTSiteWise::Types::StartSearchResponse

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::StartSearchResponse

Defined in:

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

Overview

Output of the StartSearch operation.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #group_id ⇒ String

  The group identifier associated with the search, if one was supplied on the request.

• #search_id ⇒ String

  The unique identifier assigned to the newly started search.

• #status ⇒ String

  The initial status of the search.

• #workspace_name ⇒ String

  The name of the workspace the search runs against.

Instance Attribute Details

#group_id ⇒ String

The group identifier associated with the search, if one was supplied on the request.

Returns:

• (String)

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

class StartSearchResponse < Struct.new(
  :search_id,
  :workspace_name,
  :status,
  :group_id)
  SENSITIVE = []
  include Aws::Structure
end

#search_id ⇒ String

The unique identifier assigned to the newly started search.

Returns:

• (String)

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

class StartSearchResponse < Struct.new(
  :search_id,
  :workspace_name,
  :status,
  :group_id)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The initial status of the search. A newly started search is QUEUED.

Returns:

• (String)

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

class StartSearchResponse < Struct.new(
  :search_id,
  :workspace_name,
  :status,
  :group_id)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_name ⇒ String

The name of the workspace the search runs against.

Returns:

• (String)

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

class StartSearchResponse < Struct.new(
  :search_id,
  :workspace_name,
  :status,
  :group_id)
  SENSITIVE = []
  include Aws::Structure
end