You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Kinesis::Types::GetRecordsOutput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb

Overview

Represents the output for GetRecords.

Instance Attribute Summary collapse

Instance Attribute Details

#millis_behind_latestInteger

The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates record processing is caught up, and there are no new records to process at this moment.

Returns:

  • (Integer)


415
416
417
418
419
420
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 415

class GetRecordsOutput < Struct.new(
  :records,
  :next_shard_iterator,
  :millis_behind_latest)
  include Aws::Structure
end

#next_shard_iteratorString

The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator will not return any more data.

Returns:

  • (String)


415
416
417
418
419
420
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 415

class GetRecordsOutput < Struct.new(
  :records,
  :next_shard_iterator,
  :millis_behind_latest)
  include Aws::Structure
end

#recordsArray<Types::Record>

The data records retrieved from the shard.

Returns:



415
416
417
418
419
420
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 415

class GetRecordsOutput < Struct.new(
  :records,
  :next_shard_iterator,
  :millis_behind_latest)
  include Aws::Structure
end