Class PipeSourceParameters

java.lang.Object
software.amazon.awssdk.services.pipes.model.PipeSourceParameters
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PipeSourceParameters.Builder,PipeSourceParameters>
@Generated("software.amazon.awssdk:codegen") public final class PipeSourceParameters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PipeSourceParameters.Builder,PipeSourceParameters>

The parameters required to set up a source for your pipe.

See Also:

  • Method Details

    • filterCriteria

      public final 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.

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

    • kinesisStreamParameters

      public final PipeSourceKinesisStreamParameters kinesisStreamParameters()

      The parameters for using a Kinesis stream as a source.

      Returns:
      The parameters for using a Kinesis stream as a source.

    • dynamoDBStreamParameters

      public final PipeSourceDynamoDBStreamParameters dynamoDBStreamParameters()

      The parameters for using a DynamoDB stream as a source.

      Returns:
      The parameters for using a DynamoDB stream as a source.

    • sqsQueueParameters

      public final PipeSourceSqsQueueParameters sqsQueueParameters()

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

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

    • activeMQBrokerParameters

      public final PipeSourceActiveMQBrokerParameters activeMQBrokerParameters()

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

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

    • rabbitMQBrokerParameters

      public final PipeSourceRabbitMQBrokerParameters rabbitMQBrokerParameters()

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

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

    • managedStreamingKafkaParameters

      public final PipeSourceManagedStreamingKafkaParameters managedStreamingKafkaParameters()

      The parameters for using an MSK stream as a source.

      Returns:
      The parameters for using an MSK stream as a source.

    • selfManagedKafkaParameters

      public final 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.

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

    • toBuilder

      public PipeSourceParameters.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PipeSourceParameters.Builder,PipeSourceParameters>
      Returns:
      a builder for type T

    • builder

      public static PipeSourceParameters.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PipeSourceParameters.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.