Interface PaginationConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

PaginationConfiguration

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

Method Summary

Modifier and Type	Method	Description
default PaginationConfiguration.Builder	cursorConfiguration(Consumer<CursorConfiguration.Builder> cursorConfiguration)	Configuration for cursor-based pagination, where the API provides a cursor or token to retrieve the next page of results.
PaginationConfiguration.Builder	cursorConfiguration(CursorConfiguration cursorConfiguration)	Configuration for cursor-based pagination, where the API provides a cursor or token to retrieve the next page of results.
default PaginationConfiguration.Builder	offsetConfiguration(Consumer<OffsetConfiguration.Builder> offsetConfiguration)	Configuration for offset-based pagination, where the API uses numeric offsets and limits to control which results are returned.
PaginationConfiguration.Builder	offsetConfiguration(OffsetConfiguration offsetConfiguration)	Configuration for offset-based pagination, where the API uses numeric offsets and limits to control which results are returned.

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

cursorConfiguration

PaginationConfiguration.Builder cursorConfiguration(CursorConfiguration cursorConfiguration)

Configuration for cursor-based pagination, where the API provides a cursor or token to retrieve the next page of results.

Parameters:

cursorConfiguration - Configuration for cursor-based pagination, where the API provides a cursor or token to retrieve the next page of results.

Returns:

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

cursorConfiguration

default PaginationConfiguration.Builder cursorConfiguration(Consumer<CursorConfiguration.Builder> cursorConfiguration)

Configuration for cursor-based pagination, where the API provides a cursor or token to retrieve the next page of results.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cursorConfiguration(CursorConfiguration).

Parameters:

cursorConfiguration - a consumer that will call methods on CursorConfiguration.Builder

Returns:

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

See Also:

• cursorConfiguration(CursorConfiguration)

offsetConfiguration

PaginationConfiguration.Builder offsetConfiguration(OffsetConfiguration offsetConfiguration)

Configuration for offset-based pagination, where the API uses numeric offsets and limits to control which results are returned.

Parameters:

offsetConfiguration - Configuration for offset-based pagination, where the API uses numeric offsets and limits to control which results are returned.

Returns:

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

offsetConfiguration

default PaginationConfiguration.Builder offsetConfiguration(Consumer<OffsetConfiguration.Builder> offsetConfiguration)

Configuration for offset-based pagination, where the API uses numeric offsets and limits to control which results are returned.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to offsetConfiguration(OffsetConfiguration).

Parameters:

offsetConfiguration - a consumer that will call methods on OffsetConfiguration.Builder

Returns:

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

See Also:

• offsetConfiguration(OffsetConfiguration)