Class: Aws::IoTSiteWise::Types::ListTimeSeriesRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::ListTimeSeriesRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iotsitewise/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #alias_prefix ⇒ String

  The alias prefix of the time series.

• #asset_id ⇒ String

  The ID of the asset in which the asset property was created.

• #max_results ⇒ Integer

  The maximum number of results to return for each paginated request.

• #next_token ⇒ String

  The token to be used for the next set of paginated results.

• #time_series_type ⇒ String

  The type of the time series.

Instance Attribute Details

#alias_prefix ⇒ String

The alias prefix of the time series.

Returns:

• (String)

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

class ListTimeSeriesRequest < Struct.new(
  :next_token,
  :max_results,
  :asset_id,
  :alias_prefix,
  :time_series_type)
  SENSITIVE = []
  include Aws::Structure
end

#asset_id ⇒ String

The ID of the asset in which the asset property was created. This can be either the actual ID in UUID format, or else ‘externalId:` followed by the external ID, if it has one. For more information, see [Referencing objects with external IDs] in the *IoT SiteWise User Guide*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references

Returns:

• (String)

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

class ListTimeSeriesRequest < Struct.new(
  :next_token,
  :max_results,
  :asset_id,
  :alias_prefix,
  :time_series_type)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return for each paginated request.

Returns:

• (Integer)

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

class ListTimeSeriesRequest < Struct.new(
  :next_token,
  :max_results,
  :asset_id,
  :alias_prefix,
  :time_series_type)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token to be used for the next set of paginated results.

Returns:

• (String)

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

class ListTimeSeriesRequest < Struct.new(
  :next_token,
  :max_results,
  :asset_id,
  :alias_prefix,
  :time_series_type)
  SENSITIVE = []
  include Aws::Structure
end

#time_series_type ⇒ String

The type of the time series. The time series type can be one of the following values:

• ‘ASSOCIATED` – The time series is associated with an asset property.

• ‘DISASSOCIATED` – The time series isn’t associated with any asset property.

Returns:

• (String)

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

class ListTimeSeriesRequest < Struct.new(
  :next_token,
  :max_results,
  :asset_id,
  :alias_prefix,
  :time_series_type)
  SENSITIVE = []
  include Aws::Structure
end