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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#child_shards ⇒ Array<Types::ChildShard>

The list of the current shard's child shards, returned in the GetRecords API's response only when the end of the current shard is reached.

Returns:



799
800
801
802
803
804
805
806
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 799

class GetRecordsOutput < Struct.new(
  :records,
  :next_shard_iterator,
  :millis_behind_latest,
  :child_shards)
  SENSITIVE = []
  include Aws::Structure
end

#millis_behind_latest ⇒ Integer

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 that record processing is caught up, and there are no new records to process at this moment.

Returns:

  • (Integer) 


799
800
801
802
803
804
805
806
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 799

class GetRecordsOutput < Struct.new(
  :records,
  :next_shard_iterator,
  :millis_behind_latest,
  :child_shards)
  SENSITIVE = []
  include Aws::Structure
end

#next_shard_iterator ⇒ String

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 does not return any more data.

Returns:

  • (String) 


799
800
801
802
803
804
805
806
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 799

class GetRecordsOutput < Struct.new(
  :records,
  :next_shard_iterator,
  :millis_behind_latest,
  :child_shards)
  SENSITIVE = []
  include Aws::Structure
end

#records ⇒ Array<Types::Record>

The data records retrieved from the shard.

Returns:



799
800
801
802
803
804
805
806
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 799

class GetRecordsOutput < Struct.new(
  :records,
  :next_shard_iterator,
  :millis_behind_latest,
  :child_shards)
  SENSITIVE = []
  include Aws::Structure
end