Interface OffsetConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

OffsetConfiguration

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

Method Summary

Modifier and Type	Method	Description
default OffsetConfiguration.Builder	limitParameter(Consumer<ExtractedParameter.Builder> limitParameter)	The parameter name used to specify the maximum number of results to return per page.
OffsetConfiguration.Builder	limitParameter(ExtractedParameter limitParameter)	The parameter name used to specify the maximum number of results to return per page.
default OffsetConfiguration.Builder	offsetParameter(Consumer<ExtractedParameter.Builder> offsetParameter)	The parameter name used to specify the starting position or offset for retrieving results.
OffsetConfiguration.Builder	offsetParameter(ExtractedParameter offsetParameter)	The parameter name used to specify the starting position or offset for retrieving 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

offsetParameter

OffsetConfiguration.Builder offsetParameter(ExtractedParameter offsetParameter)

The parameter name used to specify the starting position or offset for retrieving results.

Parameters:

offsetParameter - The parameter name used to specify the starting position or offset for retrieving results.

Returns:

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

offsetParameter

default OffsetConfiguration.Builder offsetParameter(Consumer<ExtractedParameter.Builder> offsetParameter)

The parameter name used to specify the starting position or offset for retrieving 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 offsetParameter(ExtractedParameter).

Parameters:

offsetParameter - 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:

• offsetParameter(ExtractedParameter)

limitParameter

OffsetConfiguration.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 OffsetConfiguration.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)