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
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default PaginationConfiguration.BuildercursorConfiguration(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.BuildercursorConfiguration(CursorConfiguration cursorConfiguration)Configuration for cursor-based pagination, where the API provides a cursor or token to retrieve the next page of results.default PaginationConfiguration.BuilderoffsetConfiguration(Consumer<OffsetConfiguration.Builder> offsetConfiguration)Configuration for offset-based pagination, where the API uses numeric offsets and limits to control which results are returned.PaginationConfiguration.BuilderoffsetConfiguration(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 Detail
-
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 theCursorConfiguration.Builderavoiding the need to create one manually viaCursorConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tocursorConfiguration(CursorConfiguration).- Parameters:
cursorConfiguration- a consumer that will call methods onCursorConfiguration.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 theOffsetConfiguration.Builderavoiding the need to create one manually viaOffsetConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tooffsetConfiguration(OffsetConfiguration).- Parameters:
offsetConfiguration- a consumer that will call methods onOffsetConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
offsetConfiguration(OffsetConfiguration)
-
-