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

Interface PipeSourceSelfManagedKafkaParameters.Builder

All Superinterfaces:

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

Enclosing class:

PipeSourceSelfManagedKafkaParameters

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

Method Summary

Modifier and Type	Method	Description
PipeSourceSelfManagedKafkaParameters.Builder	additionalBootstrapServers(String... additionalBootstrapServers)	An array of server URLs.
PipeSourceSelfManagedKafkaParameters.Builder	additionalBootstrapServers(Collection<String> additionalBootstrapServers)	An array of server URLs.
PipeSourceSelfManagedKafkaParameters.Builder	batchSize(Integer batchSize)	The maximum number of records to include in each batch.
PipeSourceSelfManagedKafkaParameters.Builder	consumerGroupID(String consumerGroupID)	The name of the destination queue to consume.
default PipeSourceSelfManagedKafkaParameters.Builder	credentials(Consumer<SelfManagedKafkaAccessConfigurationCredentials.Builder> credentials)	The credentials needed to access the resource.
PipeSourceSelfManagedKafkaParameters.Builder	credentials(SelfManagedKafkaAccessConfigurationCredentials credentials)	The credentials needed to access the resource.
PipeSourceSelfManagedKafkaParameters.Builder	maximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)	The maximum length of a time to wait for events.
PipeSourceSelfManagedKafkaParameters.Builder	serverRootCaCertificate(String serverRootCaCertificate)	The ARN of the Secrets Manager secret used for certification.
PipeSourceSelfManagedKafkaParameters.Builder	startingPosition(String startingPosition)	(Streams only) The position in a stream from which to start reading.
PipeSourceSelfManagedKafkaParameters.Builder	startingPosition(SelfManagedKafkaStartPosition startingPosition)	(Streams only) The position in a stream from which to start reading.
PipeSourceSelfManagedKafkaParameters.Builder	topicName(String topicName)	The name of the topic that the pipe will read from.
default PipeSourceSelfManagedKafkaParameters.Builder	vpc(Consumer<SelfManagedKafkaAccessConfigurationVpc.Builder> vpc)	This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
PipeSourceSelfManagedKafkaParameters.Builder	vpc(SelfManagedKafkaAccessConfigurationVpc vpc)	This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.

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

topicName

PipeSourceSelfManagedKafkaParameters.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.

startingPosition

PipeSourceSelfManagedKafkaParameters.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:

• SelfManagedKafkaStartPosition
• SelfManagedKafkaStartPosition

startingPosition

PipeSourceSelfManagedKafkaParameters.Builder startingPosition(SelfManagedKafkaStartPosition 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:

• SelfManagedKafkaStartPosition
• SelfManagedKafkaStartPosition

additionalBootstrapServers

PipeSourceSelfManagedKafkaParameters.Builder additionalBootstrapServers(Collection<String> additionalBootstrapServers)

An array of server URLs.

Parameters:

additionalBootstrapServers - An array of server URLs.

Returns:

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

additionalBootstrapServers

PipeSourceSelfManagedKafkaParameters.Builder additionalBootstrapServers(String... additionalBootstrapServers)

An array of server URLs.

Parameters:

additionalBootstrapServers - An array of server URLs.

Returns:

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

batchSize

PipeSourceSelfManagedKafkaParameters.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.

maximumBatchingWindowInSeconds

PipeSourceSelfManagedKafkaParameters.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.

consumerGroupID

PipeSourceSelfManagedKafkaParameters.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

PipeSourceSelfManagedKafkaParameters.Builder credentials(SelfManagedKafkaAccessConfigurationCredentials 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 PipeSourceSelfManagedKafkaParameters.Builder credentials(Consumer<SelfManagedKafkaAccessConfigurationCredentials.Builder> credentials)

The credentials needed to access the resource.

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

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

Parameters:

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

Returns:

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

See Also:

• credentials(SelfManagedKafkaAccessConfigurationCredentials)

serverRootCaCertificate

PipeSourceSelfManagedKafkaParameters.Builder serverRootCaCertificate(String serverRootCaCertificate)

The ARN of the Secrets Manager secret used for certification.

Parameters:

serverRootCaCertificate - The ARN of the Secrets Manager secret used for certification.

Returns:

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

vpc

PipeSourceSelfManagedKafkaParameters.Builder vpc(SelfManagedKafkaAccessConfigurationVpc vpc)

This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.

Parameters:

vpc - This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.

Returns:

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

vpc

default PipeSourceSelfManagedKafkaParameters.Builder vpc(Consumer<SelfManagedKafkaAccessConfigurationVpc.Builder> vpc)

This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.

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

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

Parameters:

vpc - a consumer that will call methods on SelfManagedKafkaAccessConfigurationVpc.Builder

Returns:

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

See Also:

• vpc(SelfManagedKafkaAccessConfigurationVpc)