Class PipeSourceSelfManagedKafkaParameters

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

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.

See Also:

  • Method Details

    • topicName

      public final String topicName()

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

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

    • startingPosition

      public final SelfManagedKafkaStartPosition startingPosition()

      The position in a stream from which to start reading.

      If the service returns an enum value that is not available in the current SDK version, startingPosition will return SelfManagedKafkaStartPosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from startingPositionAsString().

      Returns:
      The position in a stream from which to start reading.
      See Also:

    • startingPositionAsString

      public final String startingPositionAsString()

      The position in a stream from which to start reading.

      If the service returns an enum value that is not available in the current SDK version, startingPosition will return SelfManagedKafkaStartPosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from startingPositionAsString().

      Returns:
      The position in a stream from which to start reading.
      See Also:

    • hasAdditionalBootstrapServers

      public final boolean hasAdditionalBootstrapServers()
      For responses, this returns true if the service returned a value for the AdditionalBootstrapServers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • additionalBootstrapServers

      public final List<String> additionalBootstrapServers()

      An array of server URLs.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalBootstrapServers() method.

      Returns:
      An array of server URLs.

    • batchSize

      public final Integer batchSize()

      The maximum number of records to include in each batch.

      Returns:
      The maximum number of records to include in each batch.

    • maximumBatchingWindowInSeconds

      public final Integer maximumBatchingWindowInSeconds()

      The maximum length of a time to wait for events.

      Returns:
      The maximum length of a time to wait for events.

    • consumerGroupID

      public final String consumerGroupID()

      The name of the destination queue to consume.

      Returns:
      The name of the destination queue to consume.

    • credentials

      public final SelfManagedKafkaAccessConfigurationCredentials credentials()

      The credentials needed to access the resource.

      Returns:
      The credentials needed to access the resource.

    • serverRootCaCertificate

      public final String serverRootCaCertificate()

      The ARN of the Secrets Manager secret used for certification.

      Returns:
      The ARN of the Secrets Manager secret used for certification.

    • vpc

      public final SelfManagedKafkaAccessConfigurationVpc vpc()

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

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

    • toBuilder

      public PipeSourceSelfManagedKafkaParameters.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<PipeSourceSelfManagedKafkaParameters.Builder,PipeSourceSelfManagedKafkaParameters>
      Returns:
      a builder for type T

    • builder

      public static PipeSourceSelfManagedKafkaParameters.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PipeSourceSelfManagedKafkaParameters.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.