@Generated(value="software.amazon.awssdk:codegen") public class SubscribeToShardEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SubscribeToShardEvent.Builder,SubscribeToShardEvent>, SubscribeToShardEventStream
After you call SubscribeToShard, Kinesis Data Streams sends events of this type over an HTTP/2 connection to your consumer.
Modifier and Type | Class and Description |
---|---|
static interface |
SubscribeToShardEvent.Builder |
protected static class |
SubscribeToShardEvent.BuilderImpl |
SubscribeToShardEventStream.EventType
UNKNOWN
Modifier | Constructor and Description |
---|---|
protected |
SubscribeToShardEvent(SubscribeToShardEvent.BuilderImpl builder) |
Modifier and Type | Method and Description |
---|---|
void |
accept(SubscribeToShardResponseHandler.Visitor visitor)
Calls the appropriate visit method depending on the subtype of
SubscribeToShardEvent . |
static SubscribeToShardEvent.Builder |
builder() |
List<ChildShard> |
childShards()
Returns the value of the ChildShards property for this object.
|
String |
continuationSequenceNumber()
Use this as
SequenceNumber in the next call to SubscribeToShard, with
StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER . |
SubscribeToShardEvent |
copy(Consumer<? super SubscribeToShardEvent.Builder> modifier) |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasChildShards()
Returns true if the ChildShards property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasRecords()
Returns true if the Records property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
Long |
millisBehindLatest()
The number of milliseconds the read records are from the tip of the stream, indicating how far behind current
time the consumer is.
|
List<Record> |
records()
|
SubscribeToShardEventStream.EventType |
sdkEventType()
The type of this event.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends SubscribeToShardEvent.Builder> |
serializableBuilderClass() |
SubscribeToShardEvent.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
subscribeToShardEventBuilder
protected SubscribeToShardEvent(SubscribeToShardEvent.BuilderImpl builder)
public final boolean hasRecords()
public final List<Record> records()
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasRecords()
to see if a value was sent in this field.
public final String continuationSequenceNumber()
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.
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.public final Long millisBehindLatest()
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.
public final boolean hasChildShards()
public final List<ChildShard> childShards()
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasChildShards()
to see if a value was sent in this field.
public SubscribeToShardEvent.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<SubscribeToShardEvent.Builder,SubscribeToShardEvent>
public static SubscribeToShardEvent.Builder builder()
public static Class<? extends SubscribeToShardEvent.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final SubscribeToShardEvent copy(Consumer<? super SubscribeToShardEvent.Builder> modifier)
copy
in interface ToCopyableBuilder<SubscribeToShardEvent.Builder,SubscribeToShardEvent>
public SubscribeToShardEventStream.EventType sdkEventType()
SubscribeToShardEventStream
:event-type
header on the Message.sdkEventType
in interface SubscribeToShardEventStream
public void accept(SubscribeToShardResponseHandler.Visitor visitor)
SubscribeToShardEvent
.accept
in interface SubscribeToShardEventStream
visitor
- Visitor to invoke.Copyright © 2021. All rights reserved.