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 TypeMethodDescriptionThe maximum number of records to include in each batch.consumerGroupID
(String consumerGroupID) The name of the destination queue to consume.credentials
(Consumer<MSKAccessCredentials.Builder> credentials) The credentials needed to access the resource.credentials
(MSKAccessCredentials credentials) The credentials needed to access the resource.maximumBatchingWindowInSeconds
(Integer maximumBatchingWindowInSeconds) The maximum length of a time to wait for events.startingPosition
(String startingPosition) (Streams only) The position in a stream from which to start reading.startingPosition
(MSKStartPosition startingPosition) (Streams only) The position in a stream from which to start reading.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 Details
-
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
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
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 theMSKAccessCredentials.Builder
avoiding the need to create one manually viaMSKAccessCredentials.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocredentials(MSKAccessCredentials)
.- Parameters:
credentials
- a consumer that will call methods onMSKAccessCredentials.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
(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:
-
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:
-
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.
-