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

Interface PipeSourceParameters.Builder

All Superinterfaces:

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

Enclosing class:

PipeSourceParameters

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

Method Summary

Modifier and Type	Method	Description
default PipeSourceParameters.Builder	activeMQBrokerParameters(Consumer<PipeSourceActiveMQBrokerParameters.Builder> activeMQBrokerParameters)	The parameters for using an Active MQ broker as a source.
PipeSourceParameters.Builder	activeMQBrokerParameters(PipeSourceActiveMQBrokerParameters activeMQBrokerParameters)	The parameters for using an Active MQ broker as a source.
default PipeSourceParameters.Builder	dynamoDBStreamParameters(Consumer<PipeSourceDynamoDBStreamParameters.Builder> dynamoDBStreamParameters)	The parameters for using a DynamoDB stream as a source.
PipeSourceParameters.Builder	dynamoDBStreamParameters(PipeSourceDynamoDBStreamParameters dynamoDBStreamParameters)	The parameters for using a DynamoDB stream as a source.
default PipeSourceParameters.Builder	filterCriteria(Consumer<FilterCriteria.Builder> filterCriteria)	The collection of event patterns used to filter events.
PipeSourceParameters.Builder	filterCriteria(FilterCriteria filterCriteria)	The collection of event patterns used to filter events.
default PipeSourceParameters.Builder	kinesisStreamParameters(Consumer<PipeSourceKinesisStreamParameters.Builder> kinesisStreamParameters)	The parameters for using a Kinesis stream as a source.
PipeSourceParameters.Builder	kinesisStreamParameters(PipeSourceKinesisStreamParameters kinesisStreamParameters)	The parameters for using a Kinesis stream as a source.
default PipeSourceParameters.Builder	managedStreamingKafkaParameters(Consumer<PipeSourceManagedStreamingKafkaParameters.Builder> managedStreamingKafkaParameters)	The parameters for using an MSK stream as a source.
PipeSourceParameters.Builder	managedStreamingKafkaParameters(PipeSourceManagedStreamingKafkaParameters managedStreamingKafkaParameters)	The parameters for using an MSK stream as a source.
default PipeSourceParameters.Builder	rabbitMQBrokerParameters(Consumer<PipeSourceRabbitMQBrokerParameters.Builder> rabbitMQBrokerParameters)	The parameters for using a Rabbit MQ broker as a source.
PipeSourceParameters.Builder	rabbitMQBrokerParameters(PipeSourceRabbitMQBrokerParameters rabbitMQBrokerParameters)	The parameters for using a Rabbit MQ broker as a source.
default PipeSourceParameters.Builder	selfManagedKafkaParameters(Consumer<PipeSourceSelfManagedKafkaParameters.Builder> selfManagedKafkaParameters)	The parameters for using a self-managed Apache Kafka stream as a source.
PipeSourceParameters.Builder	selfManagedKafkaParameters(PipeSourceSelfManagedKafkaParameters selfManagedKafkaParameters)	The parameters for using a self-managed Apache Kafka stream as a source.
default PipeSourceParameters.Builder	sqsQueueParameters(Consumer<PipeSourceSqsQueueParameters.Builder> sqsQueueParameters)	The parameters for using a Amazon SQS stream as a source.
PipeSourceParameters.Builder	sqsQueueParameters(PipeSourceSqsQueueParameters sqsQueueParameters)	The parameters for using a Amazon SQS stream as a source.

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

filterCriteria

PipeSourceParameters.Builder filterCriteria(FilterCriteria filterCriteria)

The collection of event patterns used to filter events.

To remove a filter, specify a FilterCriteria object with an empty array of Filter objects.

For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Parameters:

filterCriteria - The collection of event patterns used to filter events.

To remove a filter, specify a FilterCriteria object with an empty array of Filter objects.

For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Returns:

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

filterCriteria

default PipeSourceParameters.Builder filterCriteria(Consumer<FilterCriteria.Builder> filterCriteria)

The collection of event patterns used to filter events.

To remove a filter, specify a FilterCriteria object with an empty array of Filter objects.

For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

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

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

Parameters:

filterCriteria - a consumer that will call methods on FilterCriteria.Builder

Returns:

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

See Also:

• filterCriteria(FilterCriteria)

kinesisStreamParameters

PipeSourceParameters.Builder kinesisStreamParameters(PipeSourceKinesisStreamParameters kinesisStreamParameters)

The parameters for using a Kinesis stream as a source.

Parameters:

kinesisStreamParameters - The parameters for using a Kinesis stream as a source.

Returns:

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

kinesisStreamParameters

default PipeSourceParameters.Builder kinesisStreamParameters(Consumer<PipeSourceKinesisStreamParameters.Builder> kinesisStreamParameters)

The parameters for using a Kinesis stream as a source.

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

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

Parameters:

kinesisStreamParameters - a consumer that will call methods on PipeSourceKinesisStreamParameters.Builder

Returns:

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

See Also:

• kinesisStreamParameters(PipeSourceKinesisStreamParameters)

dynamoDBStreamParameters

PipeSourceParameters.Builder dynamoDBStreamParameters(PipeSourceDynamoDBStreamParameters dynamoDBStreamParameters)

The parameters for using a DynamoDB stream as a source.

Parameters:

dynamoDBStreamParameters - The parameters for using a DynamoDB stream as a source.

Returns:

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

dynamoDBStreamParameters

default PipeSourceParameters.Builder dynamoDBStreamParameters(Consumer<PipeSourceDynamoDBStreamParameters.Builder> dynamoDBStreamParameters)

The parameters for using a DynamoDB stream as a source.

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

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

Parameters:

dynamoDBStreamParameters - a consumer that will call methods on PipeSourceDynamoDBStreamParameters.Builder

Returns:

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

See Also:

• dynamoDBStreamParameters(PipeSourceDynamoDBStreamParameters)

sqsQueueParameters

PipeSourceParameters.Builder sqsQueueParameters(PipeSourceSqsQueueParameters sqsQueueParameters)

The parameters for using a Amazon SQS stream as a source.

Parameters:

sqsQueueParameters - The parameters for using a Amazon SQS stream as a source.

Returns:

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

sqsQueueParameters

default PipeSourceParameters.Builder sqsQueueParameters(Consumer<PipeSourceSqsQueueParameters.Builder> sqsQueueParameters)

The parameters for using a Amazon SQS stream as a source.

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

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

Parameters:

sqsQueueParameters - a consumer that will call methods on PipeSourceSqsQueueParameters.Builder

Returns:

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

See Also:

• sqsQueueParameters(PipeSourceSqsQueueParameters)

activeMQBrokerParameters

PipeSourceParameters.Builder activeMQBrokerParameters(PipeSourceActiveMQBrokerParameters activeMQBrokerParameters)

The parameters for using an Active MQ broker as a source.

Parameters:

activeMQBrokerParameters - The parameters for using an Active MQ broker as a source.

Returns:

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

activeMQBrokerParameters

default PipeSourceParameters.Builder activeMQBrokerParameters(Consumer<PipeSourceActiveMQBrokerParameters.Builder> activeMQBrokerParameters)

The parameters for using an Active MQ broker as a source.

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

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

Parameters:

activeMQBrokerParameters - a consumer that will call methods on PipeSourceActiveMQBrokerParameters.Builder

Returns:

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

See Also:

• activeMQBrokerParameters(PipeSourceActiveMQBrokerParameters)

rabbitMQBrokerParameters

PipeSourceParameters.Builder rabbitMQBrokerParameters(PipeSourceRabbitMQBrokerParameters rabbitMQBrokerParameters)

The parameters for using a Rabbit MQ broker as a source.

Parameters:

rabbitMQBrokerParameters - The parameters for using a Rabbit MQ broker as a source.

Returns:

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

rabbitMQBrokerParameters

default PipeSourceParameters.Builder rabbitMQBrokerParameters(Consumer<PipeSourceRabbitMQBrokerParameters.Builder> rabbitMQBrokerParameters)

The parameters for using a Rabbit MQ broker as a source.

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

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

Parameters:

rabbitMQBrokerParameters - a consumer that will call methods on PipeSourceRabbitMQBrokerParameters.Builder

Returns:

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

See Also:

• rabbitMQBrokerParameters(PipeSourceRabbitMQBrokerParameters)

managedStreamingKafkaParameters

PipeSourceParameters.Builder managedStreamingKafkaParameters(PipeSourceManagedStreamingKafkaParameters managedStreamingKafkaParameters)

The parameters for using an MSK stream as a source.

Parameters:

managedStreamingKafkaParameters - The parameters for using an MSK stream as a source.

Returns:

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

managedStreamingKafkaParameters

default PipeSourceParameters.Builder managedStreamingKafkaParameters(Consumer<PipeSourceManagedStreamingKafkaParameters.Builder> managedStreamingKafkaParameters)

The parameters for using an MSK stream as a source.

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

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

Parameters:

managedStreamingKafkaParameters - a consumer that will call methods on PipeSourceManagedStreamingKafkaParameters.Builder

Returns:

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

See Also:

• managedStreamingKafkaParameters(PipeSourceManagedStreamingKafkaParameters)

selfManagedKafkaParameters

PipeSourceParameters.Builder selfManagedKafkaParameters(PipeSourceSelfManagedKafkaParameters selfManagedKafkaParameters)

The parameters for using a self-managed Apache Kafka stream as a source.

A self managed cluster refers to any Apache Kafka cluster not hosted by Amazon Web Services. This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as Confluent Cloud, CloudKarafka, or Redpanda. For more information, see Apache Kafka streams as a source in the Amazon EventBridge User Guide.

Parameters:

selfManagedKafkaParameters - The parameters for using a self-managed Apache Kafka stream as a source.

A self managed cluster refers to any Apache Kafka cluster not hosted by Amazon Web Services. This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as Confluent Cloud, CloudKarafka, or Redpanda. For more information, see Apache Kafka streams as a source in the Amazon EventBridge User Guide.

Returns:

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

selfManagedKafkaParameters

default PipeSourceParameters.Builder selfManagedKafkaParameters(Consumer<PipeSourceSelfManagedKafkaParameters.Builder> selfManagedKafkaParameters)

The parameters for using a self-managed Apache Kafka stream as a source.

A self managed cluster refers to any Apache Kafka cluster not hosted by Amazon Web Services. This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as Confluent Cloud, CloudKarafka, or Redpanda. For more information, see Apache Kafka streams as a source in the Amazon EventBridge User Guide.

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

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

Parameters:

selfManagedKafkaParameters - a consumer that will call methods on PipeSourceSelfManagedKafkaParameters.Builder

Returns:

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

See Also:

• selfManagedKafkaParameters(PipeSourceSelfManagedKafkaParameters)