Class: Aws::IoTAnalytics::Types::SampleChannelDataRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTAnalytics::Types::SampleChannelDataRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iotanalytics/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #channel_name ⇒ String

  The name of the channel whose message samples are retrieved.

• #end_time ⇒ Time

  The end of the time window from which sample messages are retrieved.

• #max_messages ⇒ Integer

  The number of sample messages to be retrieved.

• #start_time ⇒ Time

  The start of the time window from which sample messages are retrieved.

Instance Attribute Details

#channel_name ⇒ String

The name of the channel whose message samples are retrieved.

Returns:

• (String)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 2667

class SampleChannelDataRequest < Struct.new(
  :channel_name,
  :max_messages,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The end of the time window from which sample messages are retrieved.

Returns:

• (Time)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 2667

class SampleChannelDataRequest < Struct.new(
  :channel_name,
  :max_messages,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#max_messages ⇒ Integer

The number of sample messages to be retrieved. The limit is 10. The default is also 10.

Returns:

• (Integer)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 2667

class SampleChannelDataRequest < Struct.new(
  :channel_name,
  :max_messages,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The start of the time window from which sample messages are retrieved.

Returns:

• (Time)

# File 'lib/aws-sdk-iotanalytics/types.rb', line 2667

class SampleChannelDataRequest < Struct.new(
  :channel_name,
  :max_messages,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end