Interface CursorConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

CursorConfiguration

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

Method Summary

Modifier and Type	Method	Description
default CursorConfiguration.Builder	limitParameter(Consumer<ExtractedParameter.Builder> limitParameter)	The parameter name used to specify the maximum number of results to return per page.
CursorConfiguration.Builder	limitParameter(ExtractedParameter limitParameter)	The parameter name used to specify the maximum number of results to return per page.
default CursorConfiguration.Builder	nextPage(Consumer<ExtractedParameter.Builder> nextPage)	The parameter name or JSON path that contains the cursor or token for retrieving the next page of results.
CursorConfiguration.Builder	nextPage(ExtractedParameter nextPage)	The parameter name or JSON path that contains the cursor or token for retrieving the next page of results.

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

nextPage

CursorConfiguration.Builder nextPage(ExtractedParameter nextPage)

The parameter name or JSON path that contains the cursor or token for retrieving the next page of results.

Parameters:

nextPage - The parameter name or JSON path that contains the cursor or token for retrieving the next page of results.

Returns:

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

nextPage

default CursorConfiguration.Builder nextPage(Consumer<ExtractedParameter.Builder> nextPage)

The parameter name or JSON path that contains the cursor or token for retrieving the next page of results.

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

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

Parameters:

nextPage - a consumer that will call methods on ExtractedParameter.Builder

Returns:

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

See Also:

• nextPage(ExtractedParameter)

limitParameter

CursorConfiguration.Builder limitParameter(ExtractedParameter limitParameter)

The parameter name used to specify the maximum number of results to return per page.

Parameters:

limitParameter - The parameter name used to specify the maximum number of results to return per page.

Returns:

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

limitParameter

default CursorConfiguration.Builder limitParameter(Consumer<ExtractedParameter.Builder> limitParameter)

The parameter name used to specify the maximum number of results to return per page.

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

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

Parameters:

limitParameter - a consumer that will call methods on ExtractedParameter.Builder

Returns:

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

See Also:

• limitParameter(ExtractedParameter)