Class: Aws::Kinesis::Types::SubscribeToShardEvent

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

Overview

After you call SubscribeToShard, Kinesis Data Streams sends events of this type over an HTTP/2 connection to your consumer.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#child_shards ⇒ Array<Types::ChildShard>

The list of the child shards of the current shard, returned only at the end of the current shard.

Returns:



2401
2402
2403
2404
2405
2406
2407
2408
2409
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2401

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

#continuation_sequence_number ⇒ String

Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER. Use ContinuationSequenceNumber for checkpointing because it captures your shard progress even when no data is written to the shard.

Returns:

  • (String) 


2401
2402
2403
2404
2405
2406
2407
2408
2409
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2401

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

#event_type ⇒ Object

Returns the value of attribute event_type

Returns:

  • (Object) —

    the current value of event_type



2401
2402
2403
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2401

def event_type
  @event_type
end

#millis_behind_latest ⇒ Integer

The number of milliseconds the read records are 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) 


2401
2402
2403
2404
2405
2406
2407
2408
2409
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2401

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

#records ⇒ Array<Types::Record>

Returns:



2401
2402
2403
2404
2405
2406
2407
2408
2409
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2401

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