Interface IteratorDescription.Builder

All Superinterfaces:

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

Enclosing class:

IteratorDescription

@Mutable
@NotThreadSafe
public static interface IteratorDescription.Builder
extends SdkPojo, CopyableBuilder<IteratorDescription.Builder,IteratorDescription>

Method Summary

Modifier and Type	Method	Description
IteratorDescription.Builder	iteratorPosition(String iteratorPosition)	Indicates the current iterator's position within the shard.
IteratorDescription.Builder	iteratorPosition(IteratorPosition iteratorPosition)	Indicates the current iterator's position within the shard.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

iteratorPosition

IteratorDescription.Builder iteratorPosition(String iteratorPosition)

Indicates the current iterator's position within the shard. The possible values are:

• AT_TIP - No more records are currently available.

• BEHIND_TIP - Additional records may be available.

Stream progresses in absence of customer records. BEHIND_TIP with an empty changeRecords list indicates the stream is progressing but no customer records are available at this position. Continue polling normally.

Parameters:

iteratorPosition - Indicates the current iterator's position within the shard. The possible values are:

• AT_TIP - No more records are currently available.

• BEHIND_TIP - Additional records may be available.

Stream progresses in absence of customer records. BEHIND_TIP with an empty changeRecords list indicates the stream is progressing but no customer records are available at this position. Continue polling normally.

Returns:

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

See Also:

• IteratorPosition
• IteratorPosition

iteratorPosition

IteratorDescription.Builder iteratorPosition(IteratorPosition iteratorPosition)

Indicates the current iterator's position within the shard. The possible values are:

• AT_TIP - No more records are currently available.

• BEHIND_TIP - Additional records may be available.

Stream progresses in absence of customer records. BEHIND_TIP with an empty changeRecords list indicates the stream is progressing but no customer records are available at this position. Continue polling normally.

Parameters:

iteratorPosition - Indicates the current iterator's position within the shard. The possible values are:

• AT_TIP - No more records are currently available.

• BEHIND_TIP - Additional records may be available.

Stream progresses in absence of customer records. BEHIND_TIP with an empty changeRecords list indicates the stream is progressing but no customer records are available at this position. Continue polling normally.

Returns:

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

See Also:

• IteratorPosition
• IteratorPosition