Package io.pravega.client.tables

Interface KeyValueTableIterator.Builder

Enclosing interface:

KeyValueTableIterator

public static interface KeyValueTableIterator.Builder

Defines a Builder for a KeyValueTableIterator.

Method Summary

Modifier and Type	Method	Description
KeyValueTableIterator	all()	Creates a new KeyValueTableIterator that returns all the TableKey/TableEntry instances in the associated KeyValueTable.
KeyValueTableIterator	forPrefix(java.nio.ByteBuffer primaryKeyPrefix)	Creates a new KeyValueTableIterator that returns TableKey/TableEntry instances with Primary Keys (see TableKey.getPrimaryKey() that begin with the given prefix.
KeyValueTableIterator	forPrimaryKey(@NonNull java.nio.ByteBuffer primaryKey)	Creates a new KeyValueTableIterator that returns TableKey/TableEntry instances with the same Primary Key (see TableKey.getPrimaryKey().
KeyValueTableIterator	forPrimaryKey(@NonNull java.nio.ByteBuffer primaryKey, java.nio.ByteBuffer secondaryKeyPrefix)	Creates a new KeyValueTableIterator that returns TableKey/TableEntry instances with the same Primary Key (see TableKey.getPrimaryKey() and all Secondary keys (see TableKey.getSecondaryKey()) that begin with the given prefix.
KeyValueTableIterator	forPrimaryKey(@NonNull java.nio.ByteBuffer primaryKey, java.nio.ByteBuffer fromSecondaryKey, java.nio.ByteBuffer toSecondaryKey)	Creates a new KeyValueTableIterator that returns TableKey/TableEntry instances with the same Primary Key (see TableKey.getPrimaryKey().
KeyValueTableIterator	forRange(java.nio.ByteBuffer fromPrimaryKey, java.nio.ByteBuffer toPrimaryKey)	Creates a new KeyValueTableIterator that returns TableKey/TableEntry instances with Primary Keys (see TableKey.getPrimaryKey() between the two values.
KeyValueTableIterator.Builder	maxIterationSize(int maxIterationSize)	Sets the maximum number of items to return with each call to AsyncIterator.getNext().

Method Detail

maxIterationSize

KeyValueTableIterator.Builder maxIterationSize(int maxIterationSize)

Sets the maximum number of items to return with each call to AsyncIterator.getNext().

Parameters:

maxIterationSize - The maximum number of items to return with each call to AsyncIterator.getNext().

Returns:

This instance.

forPrimaryKey

KeyValueTableIterator forPrimaryKey(@NonNull
                                    @NonNull java.nio.ByteBuffer primaryKey)

Creates a new KeyValueTableIterator that returns TableKey/TableEntry instances with the same Primary Key (see TableKey.getPrimaryKey(). This will iterate through all TableKey/TableEntry instances matching the given Primary Key.

Parameters:

primaryKey - A ByteBuffer representing the full Primary Key to search.

Returns:

A new KeyValueTableIterator that can be used for the iteration.

forPrimaryKey

KeyValueTableIterator forPrimaryKey(@NonNull
                                    @NonNull java.nio.ByteBuffer primaryKey,
                                    @Nullable
                                    java.nio.ByteBuffer fromSecondaryKey,
                                    @Nullable
                                    java.nio.ByteBuffer toSecondaryKey)

Creates a new KeyValueTableIterator that returns TableKey/TableEntry instances with the same Primary Key (see TableKey.getPrimaryKey(). Depending on the arguments provided, this may iterate through all TableKey/TableEntry instances matching the given Primary Key or a sub-range.

Parameters:

primaryKey - A ByteBuffer representing the full Primary Key to search.

fromSecondaryKey - A ByteBuffer that indicates the Secondary Key (see TableKey.getSecondaryKey()) to begin the iteration at. If not provided (null), the iterator will begin with the first TableKey/TableEntry that has the given Primary Key. This argument is inclusive.

toSecondaryKey - A ByteBuffer that indicates the Secondary Key (see TableKey.getSecondaryKey()) to end the iteration at. If not provided (null), the iterator will end with the last TableKey/TableEntry that has the given Primary Key. This argument is inclusive.

Returns:

A new KeyValueTableIterator that can be used for the iteration.

forPrimaryKey

KeyValueTableIterator forPrimaryKey(@NonNull
                                    @NonNull java.nio.ByteBuffer primaryKey,
                                    @Nullable
                                    java.nio.ByteBuffer secondaryKeyPrefix)

Creates a new KeyValueTableIterator that returns TableKey/TableEntry instances with the same Primary Key (see TableKey.getPrimaryKey() and all Secondary keys (see TableKey.getSecondaryKey()) that begin with the given prefix. Depending on the arguments provided, this may iterate through all TableKey/TableEntry instances matching the given Primary Key or a sub-range.

Parameters:

primaryKey - A ByteBuffer representing the full Primary Key to search.

secondaryKeyPrefix - A ByteBuffer that indicates the Secondary Key prefix for all TableKey/ TableEntry instances to return. If not provided (null), the iterator will list all TableKey/TableEntry instances that match the given Primary Key.

Returns:

A new KeyValueTableIterator that can be used for the iteration.

forRange

KeyValueTableIterator forRange(@Nullable
                               java.nio.ByteBuffer fromPrimaryKey,
                               @Nullable
                               java.nio.ByteBuffer toPrimaryKey)

Creates a new KeyValueTableIterator that returns TableKey/TableEntry instances with Primary Keys (see TableKey.getPrimaryKey() between the two values. Depending on the arguments provided, this may iterate through all TableKey/TableEntry instances within the KeyValueTable or a sub-range.

Parameters:

fromPrimaryKey - A ByteBuffer that indicates the Primary Key (see TableKey.getPrimaryKey()) to begin the iteration at. If not provided (null), the iterator will begin with the first TableKey/TableEntry in the KeyValueTable. This argument is inclusive.

toPrimaryKey - A ByteBuffer that indicates the Primary Key (see TableKey.getPrimaryKey()) to end the iteration at. If not provided (null), the iterator will end with the last TableKey/TableEntry in the KeyValueTable. This argument is inclusive.

Returns:

A new KeyValueTableIterator that can be used for the iteration.

forPrefix

KeyValueTableIterator forPrefix(@Nullable
                                java.nio.ByteBuffer primaryKeyPrefix)

Creates a new KeyValueTableIterator that returns TableKey/TableEntry instances with Primary Keys (see TableKey.getPrimaryKey() that begin with the given prefix. Depending on the arguments provided, this may iterate through all TableKey/TableEntry instances within the KeyValueTable or a sub-range.

Parameters:

primaryKeyPrefix - A ByteBuffer that indicates the Primary Key prefix for all TableKey/ TableEntry instances to return. If not provided (null), the iterator will list all TableKey/TableEntry instances in the KeyValueTable.

Returns:

A new KeyValueTableIterator that can be used for the iteration.

all

KeyValueTableIterator all()

Creates a new KeyValueTableIterator that returns all the TableKey/TableEntry instances in the associated KeyValueTable.

Returns:

A new KeyValueTableIterator that can be used for the iteration.