Package software.amazon.awssdk.services.kinesis.model

Class SubscribeToShardEvent.BuilderImpl

java.lang.Object

software.amazon.awssdk.services.kinesis.model.SubscribeToShardEvent.BuilderImpl

All Implemented Interfaces:

SdkPojo, SubscribeToShardEvent.Builder, Buildable, CopyableBuilder<SubscribeToShardEvent.Builder,SubscribeToShardEvent>, SdkBuilder<SubscribeToShardEvent.Builder,SubscribeToShardEvent>

Enclosing class:

SubscribeToShardEvent

protected static class SubscribeToShardEvent.BuilderImpl
extends Object
implements SubscribeToShardEvent.Builder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuilderImpl()
protected	BuilderImpl(SubscribeToShardEvent model)

Method Summary

Modifier and Type	Method	Description
SubscribeToShardEvent	build()
final SubscribeToShardEvent.Builder	childShards(Collection<ChildShard> childShards)	The list of the child shards of the current shard, returned only at the end of the current shard.
final SubscribeToShardEvent.Builder	childShards(Consumer<ChildShard.Builder>... childShards)	The list of the child shards of the current shard, returned only at the end of the current shard.
final SubscribeToShardEvent.Builder	childShards(ChildShard... childShards)	The list of the child shards of the current shard, returned only at the end of the current shard.
final SubscribeToShardEvent.Builder	continuationSequenceNumber(String continuationSequenceNumber)	Use this as SequenceNumber in the next call to SubscribeToShard, with StartingPosition set to AT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER.
final List<ChildShard.Builder>	getChildShards()
final String	getContinuationSequenceNumber()
final Long	getMillisBehindLatest()
final List<Record.Builder>	getRecords()
final SubscribeToShardEvent.Builder	millisBehindLatest(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.
final SubscribeToShardEvent.Builder	records(Collection<Record> records)
final SubscribeToShardEvent.Builder	records(Consumer<Record.Builder>... records)	This is a convenience method that creates an instance of the Record.Builder avoiding the need to create one manually via Record.builder().
final SubscribeToShardEvent.Builder	records(Record... records)
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
final void	setChildShards(Collection<software.amazon.awssdk.services.kinesis.model.ChildShard.BuilderImpl> childShards)
final void	setContinuationSequenceNumber(String continuationSequenceNumber)
final void	setMillisBehindLatest(Long millisBehindLatest)
final void	setRecords(Collection<software.amazon.awssdk.services.kinesis.model.Record.BuilderImpl> records)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields

Constructor Details

BuilderImpl

protected BuilderImpl()

BuilderImpl

protected BuilderImpl(SubscribeToShardEvent model)

Method Details

getRecords

public final List<Record.Builder> getRecords()

setRecords

public final void setRecords(Collection<software.amazon.awssdk.services.kinesis.model.Record.BuilderImpl> records)

records

public final SubscribeToShardEvent.Builder records(Collection<Record> records)

Description copied from interface: SubscribeToShardEvent.Builder

Specified by:

records in interface SubscribeToShardEvent.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

records

@SafeVarargs
public final SubscribeToShardEvent.Builder records(Record... records)

Description copied from interface: SubscribeToShardEvent.Builder

Specified by:

records in interface SubscribeToShardEvent.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

records

@SafeVarargs
public final SubscribeToShardEvent.Builder records(Consumer<Record.Builder>... records)

Description copied from interface: SubscribeToShardEvent.Builder

This is a convenience method that creates an instance of the Record.Builder avoiding the need to create one manually via Record.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to SubscribeToShardEvent.Builder.records(List<Record>).

Specified by:

records in interface SubscribeToShardEvent.Builder

Parameters:

records - a consumer that will call methods on Record.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• SubscribeToShardEvent.Builder.records(java.util.Collection<Record>)

getContinuationSequenceNumber

public final String getContinuationSequenceNumber()

setContinuationSequenceNumber

public final void setContinuationSequenceNumber(String continuationSequenceNumber)

continuationSequenceNumber

public final SubscribeToShardEvent.Builder continuationSequenceNumber(String continuationSequenceNumber)

Description copied from interface: SubscribeToShardEvent.Builder

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.

Specified by:

continuationSequenceNumber in interface SubscribeToShardEvent.Builder

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getMillisBehindLatest

public final Long getMillisBehindLatest()

setMillisBehindLatest

public final void setMillisBehindLatest(Long millisBehindLatest)

millisBehindLatest

public final SubscribeToShardEvent.Builder millisBehindLatest(Long millisBehindLatest)

Description copied from interface: SubscribeToShardEvent.Builder

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.

Specified by:

millisBehindLatest in interface SubscribeToShardEvent.Builder

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getChildShards

public final List<ChildShard.Builder> getChildShards()

setChildShards

public final void setChildShards(Collection<software.amazon.awssdk.services.kinesis.model.ChildShard.BuilderImpl> childShards)

childShards

public final SubscribeToShardEvent.Builder childShards(Collection<ChildShard> childShards)

Description copied from interface: SubscribeToShardEvent.Builder

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

Specified by:

childShards in interface SubscribeToShardEvent.Builder

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

childShards

@SafeVarargs
public final SubscribeToShardEvent.Builder childShards(ChildShard... childShards)

Description copied from interface: SubscribeToShardEvent.Builder

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

Specified by:

childShards in interface SubscribeToShardEvent.Builder

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

childShards

@SafeVarargs
public final SubscribeToShardEvent.Builder childShards(Consumer<ChildShard.Builder>... childShards)

Description copied from interface: SubscribeToShardEvent.Builder

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

This is a convenience method that creates an instance of the ChildShard.Builder avoiding the need to create one manually via ChildShard.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to SubscribeToShardEvent.Builder.childShards(List<ChildShard>).

Specified by:

childShards in interface SubscribeToShardEvent.Builder

Parameters:

childShards - a consumer that will call methods on ChildShard.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• SubscribeToShardEvent.Builder.childShards(java.util.Collection<ChildShard>)

build

public SubscribeToShardEvent build()

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<SubscribeToShardEvent.Builder,SubscribeToShardEvent>

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo