Class MSKSourceConfiguration

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

The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.

See Also:

  • Method Details

    • mskClusterARN

      public final String mskClusterARN()

      The ARN of the Amazon MSK cluster.

      Returns:
      The ARN of the Amazon MSK cluster.

    • topicName

      public final String topicName()

      The topic name within the Amazon MSK cluster.

      Returns:
      The topic name within the Amazon MSK cluster.

    • authenticationConfiguration

      public final AuthenticationConfiguration authenticationConfiguration()

      The authentication configuration of the Amazon MSK cluster.

      Returns:
      The authentication configuration of the Amazon MSK cluster.

    • readFromTimestamp

      public final Instant readFromTimestamp()

      The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.

      If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the ReadFromTimestamp parameter to Epoch (1970-01-01T00:00:00Z).

      Returns:
      The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.

      If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the ReadFromTimestamp parameter to Epoch (1970-01-01T00:00:00Z).

    • toBuilder

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

    • builder

      public static MSKSourceConfiguration.Builder builder()

    • serializableBuilderClass

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