Package software.amazon.awssdk.services.databasemigration.model

Class KinesisSettings

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

Provides information that describes an Amazon Kinesis Data Stream endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information.

See Also:

  • Method Details

    • streamArn

      public final String streamArn()

      The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

      Returns:
      The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

    • messageFormat

      public final MessageFormatValue messageFormat()

      The output format for the records created on the endpoint. The message format is JSON (default) or JSON_UNFORMATTED (a single line with no tab).

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

      Returns:
      The output format for the records created on the endpoint. The message format is JSON (default) or JSON_UNFORMATTED (a single line with no tab).
      See Also:

    • messageFormatAsString

      public final String messageFormatAsString()

      The output format for the records created on the endpoint. The message format is JSON (default) or JSON_UNFORMATTED (a single line with no tab).

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

      Returns:
      The output format for the records created on the endpoint. The message format is JSON (default) or JSON_UNFORMATTED (a single line with no tab).
      See Also:

    • serviceAccessRoleArn

      public final String serviceAccessRoleArn()

      The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Kinesis data stream. The role must allow the iam:PassRole action.

      Returns:
      The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Kinesis data stream. The role must allow the iam:PassRole action.

    • includeTransactionDetails

      public final Boolean includeTransactionDetails()

      Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for transaction_id, previous transaction_id, and transaction_record_id (the record offset within a transaction). The default is false.

      Returns:
      Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for transaction_id, previous transaction_id, and transaction_record_id (the record offset within a transaction). The default is false.

    • includePartitionValue

      public final Boolean includePartitionValue()

      Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type. The default is false.

      Returns:
      Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type. The default is false.

    • partitionIncludeSchemaTable

      public final Boolean partitionIncludeSchemaTable()

      Prefixes schema and table names to partition values, when the partition type is primary-key-type. Doing this increases data distribution among Kinesis shards. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same shard, which causes throttling. The default is false.

      Returns:
      Prefixes schema and table names to partition values, when the partition type is primary-key-type. Doing this increases data distribution among Kinesis shards. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same shard, which causes throttling. The default is false.

    • includeTableAlterOperations

      public final Boolean includeTableAlterOperations()

      Includes any data definition language (DDL) operations that change the table in the control data, such as rename-table, drop-table, add-column, drop-column, and rename-column. The default is false.

      Returns:
      Includes any data definition language (DDL) operations that change the table in the control data, such as rename-table, drop-table, add-column, drop-column, and rename-column. The default is false.

    • includeControlDetails

      public final Boolean includeControlDetails()

      Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false.

      Returns:
      Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false.

    • includeNullAndEmpty

      public final Boolean includeNullAndEmpty()

      Include NULL and empty columns for records migrated to the endpoint. The default is false.

      Returns:
      Include NULL and empty columns for records migrated to the endpoint. The default is false.

    • noHexPrefix

      public final Boolean noHexPrefix()

      Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to an Amazon Kinesis target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.

      Returns:
      Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to an Amazon Kinesis target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.

    • toBuilder

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

    • builder

      public static KinesisSettings.Builder builder()

    • serializableBuilderClass

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