Class RecordConfiguration

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

Specifies the format of records read from the source stream.

See Also:

  • Method Details

    • recordFormatType

      public final RecordFormatType recordFormatType()

      The format of records on the source stream. Valid values:

      • GSR_JSON - Supported only for streaming table (Amazon S3 Tables) destinations.

      • JSON - Supported for both general purpose Amazon S3 and streaming table destinations.

      • STRING - Supported only for general purpose Amazon S3 destinations.

      • BYTE_ARRAY - Supported only for general purpose Amazon S3 destinations.

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

      Returns:
      The format of records on the source stream. Valid values:

      • GSR_JSON - Supported only for streaming table (Amazon S3 Tables) destinations.

      • JSON - Supported for both general purpose Amazon S3 and streaming table destinations.

      • STRING - Supported only for general purpose Amazon S3 destinations.

      • BYTE_ARRAY - Supported only for general purpose Amazon S3 destinations.

      See Also:

    • recordFormatTypeAsString

      public final String recordFormatTypeAsString()

      The format of records on the source stream. Valid values:

      • GSR_JSON - Supported only for streaming table (Amazon S3 Tables) destinations.

      • JSON - Supported for both general purpose Amazon S3 and streaming table destinations.

      • STRING - Supported only for general purpose Amazon S3 destinations.

      • BYTE_ARRAY - Supported only for general purpose Amazon S3 destinations.

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

      Returns:
      The format of records on the source stream. Valid values:

      • GSR_JSON - Supported only for streaming table (Amazon S3 Tables) destinations.

      • JSON - Supported for both general purpose Amazon S3 and streaming table destinations.

      • STRING - Supported only for general purpose Amazon S3 destinations.

      • BYTE_ARRAY - Supported only for general purpose Amazon S3 destinations.

      See Also:

    • gsrSchemaARN

      public final String gsrSchemaARN()

      The Amazon Resource Name (ARN) of the Amazon Web Services Glue Schema Registry schema used to validate records. Required when the channel destination is a streaming table (Amazon S3 Tables), for both the JSON and GSR_JSON record formats.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon Web Services Glue Schema Registry schema used to validate records. Required when the channel destination is a streaming table (Amazon S3 Tables), for both the JSON and GSR_JSON record formats.

    • toBuilder

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

    • builder

      public static RecordConfiguration.Builder builder()

    • serializableBuilderClass

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