Package software.amazon.awssdk.services.pipes.model

Interface PipeSourceManagedStreamingKafkaParameters.Builder

All Superinterfaces:

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

Enclosing class:

PipeSourceManagedStreamingKafkaParameters

public static interface PipeSourceManagedStreamingKafkaParameters.Builder
extends SdkPojo, CopyableBuilder<PipeSourceManagedStreamingKafkaParameters.Builder,PipeSourceManagedStreamingKafkaParameters>

Method Summary

Modifier and Type	Method	Description
PipeSourceManagedStreamingKafkaParameters.Builder	batchSize(Integer batchSize)	The maximum number of records to include in each batch.
PipeSourceManagedStreamingKafkaParameters.Builder	consumerGroupID(String consumerGroupID)	The name of the destination queue to consume.
default PipeSourceManagedStreamingKafkaParameters.Builder	credentials(Consumer<MSKAccessCredentials.Builder> credentials)	The credentials needed to access the resource.
PipeSourceManagedStreamingKafkaParameters.Builder	credentials(MSKAccessCredentials credentials)	The credentials needed to access the resource.
PipeSourceManagedStreamingKafkaParameters.Builder	maximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)	The maximum length of a time to wait for events.
PipeSourceManagedStreamingKafkaParameters.Builder	startingPosition(String startingPosition)	(Streams only) The position in a stream from which to start reading.
PipeSourceManagedStreamingKafkaParameters.Builder	startingPosition(MSKStartPosition startingPosition)	(Streams only) The position in a stream from which to start reading.
PipeSourceManagedStreamingKafkaParameters.Builder	topicName(String topicName)	The name of the topic that the pipe will read from.

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, sdkFields

Method Detail

batchSize

PipeSourceManagedStreamingKafkaParameters.Builder batchSize(Integer batchSize)

The maximum number of records to include in each batch.

Parameters:

batchSize - The maximum number of records to include in each batch.

Returns:

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

consumerGroupID

PipeSourceManagedStreamingKafkaParameters.Builder consumerGroupID(String consumerGroupID)

The name of the destination queue to consume.

Parameters:

consumerGroupID - The name of the destination queue to consume.

Returns:

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

credentials

PipeSourceManagedStreamingKafkaParameters.Builder credentials(MSKAccessCredentials credentials)

The credentials needed to access the resource.

Parameters:

credentials - The credentials needed to access the resource.

Returns:

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

credentials

default PipeSourceManagedStreamingKafkaParameters.Builder credentials(Consumer<MSKAccessCredentials.Builder> credentials)

The credentials needed to access the resource.

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

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

Parameters:

credentials - a consumer that will call methods on MSKAccessCredentials.Builder

Returns:

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

See Also:

credentials(MSKAccessCredentials)

maximumBatchingWindowInSeconds

PipeSourceManagedStreamingKafkaParameters.Builder maximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)

The maximum length of a time to wait for events.

Parameters:

maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.

Returns:

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

startingPosition

PipeSourceManagedStreamingKafkaParameters.Builder startingPosition(String startingPosition)

(Streams only) The position in a stream from which to start reading.

Parameters:

startingPosition - (Streams only) The position in a stream from which to start reading.

Returns:

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

See Also:

MSKStartPosition, MSKStartPosition

startingPosition

PipeSourceManagedStreamingKafkaParameters.Builder startingPosition(MSKStartPosition startingPosition)

(Streams only) The position in a stream from which to start reading.

Parameters:

startingPosition - (Streams only) The position in a stream from which to start reading.

Returns:

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

See Also:

MSKStartPosition, MSKStartPosition

topicName

PipeSourceManagedStreamingKafkaParameters.Builder topicName(String topicName)

The name of the topic that the pipe will read from.

Parameters:

topicName - The name of the topic that the pipe will read from.

Returns:

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