KafkaSettings (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.databasemigrationservice.model.KafkaSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class KafkaSettings
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides information that describes an Apache Kafka endpoint. This information includes the output format of records applied to the endpoint and details of transaction and control table data information.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

KafkaSettings()

Constructors
Constructor and Description
`KafkaSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KafkaSettings`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBroker()` The broker location and port of the Kafka broker that hosts your Kafka instance.
`Boolean`	`getIncludeControlDetails()` Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output.
`Boolean`	`getIncludeNullAndEmpty()` Include NULL and empty columns for records migrated to the endpoint.
`Boolean`	`getIncludePartitionValue()` Shows the partition value within the Kafka message output, unless the partition type is `schema-table-type`.
`Boolean`	`getIncludeTableAlterOperations()` 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`.
`Boolean`	`getIncludeTransactionDetails()` Provides detailed transaction information from the source database.
`String`	`getMessageFormat()` The output format for the records created on the endpoint.
`Integer`	`getMessageMaxBytes()` The maximum size in bytes for records created on the endpoint The default is 1,000,000.
`Boolean`	`getPartitionIncludeSchemaTable()` Prefixes schema and table names to partition values, when the partition type is `primary-key-type`.
`String`	`getTopic()` The topic to which you migrate the data.
`int`	`hashCode()`
`Boolean`	`isIncludeControlDetails()` Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output.
`Boolean`	`isIncludeNullAndEmpty()` Include NULL and empty columns for records migrated to the endpoint.
`Boolean`	`isIncludePartitionValue()` Shows the partition value within the Kafka message output, unless the partition type is `schema-table-type`.
`Boolean`	`isIncludeTableAlterOperations()` 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`.
`Boolean`	`isIncludeTransactionDetails()` Provides detailed transaction information from the source database.
`Boolean`	`isPartitionIncludeSchemaTable()` Prefixes schema and table names to partition values, when the partition type is `primary-key-type`.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBroker(String broker)` The broker location and port of the Kafka broker that hosts your Kafka instance.
`void`	`setIncludeControlDetails(Boolean includeControlDetails)` Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output.
`void`	`setIncludeNullAndEmpty(Boolean includeNullAndEmpty)` Include NULL and empty columns for records migrated to the endpoint.
`void`	`setIncludePartitionValue(Boolean includePartitionValue)` Shows the partition value within the Kafka message output, unless the partition type is `schema-table-type`.
`void`	`setIncludeTableAlterOperations(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`.
`void`	`setIncludeTransactionDetails(Boolean includeTransactionDetails)` Provides detailed transaction information from the source database.
`void`	`setMessageFormat(String messageFormat)` The output format for the records created on the endpoint.
`void`	`setMessageMaxBytes(Integer messageMaxBytes)` The maximum size in bytes for records created on the endpoint The default is 1,000,000.
`void`	`setPartitionIncludeSchemaTable(Boolean partitionIncludeSchemaTable)` Prefixes schema and table names to partition values, when the partition type is `primary-key-type`.
`void`	`setTopic(String topic)` The topic to which you migrate the data.
`String`	`toString()` Returns a string representation of this object.
`KafkaSettings`	`withBroker(String broker)` The broker location and port of the Kafka broker that hosts your Kafka instance.
`KafkaSettings`	`withIncludeControlDetails(Boolean includeControlDetails)` Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output.
`KafkaSettings`	`withIncludeNullAndEmpty(Boolean includeNullAndEmpty)` Include NULL and empty columns for records migrated to the endpoint.
`KafkaSettings`	`withIncludePartitionValue(Boolean includePartitionValue)` Shows the partition value within the Kafka message output, unless the partition type is `schema-table-type`.
`KafkaSettings`	`withIncludeTableAlterOperations(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`.
`KafkaSettings`	`withIncludeTransactionDetails(Boolean includeTransactionDetails)` Provides detailed transaction information from the source database.
`KafkaSettings`	`withMessageFormat(MessageFormatValue messageFormat)` The output format for the records created on the endpoint.
`KafkaSettings`	`withMessageFormat(String messageFormat)` The output format for the records created on the endpoint.
`KafkaSettings`	`withMessageMaxBytes(Integer messageMaxBytes)` The maximum size in bytes for records created on the endpoint The default is 1,000,000.
`KafkaSettings`	`withPartitionIncludeSchemaTable(Boolean partitionIncludeSchemaTable)` Prefixes schema and table names to partition values, when the partition type is `primary-key-type`.
`KafkaSettings`	`withTopic(String topic)` The topic to which you migrate the data.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - KafkaSettings
```
public KafkaSettings()
```
- Method Detail
  - setBroker
```
public void setBroker(String broker)
```
    The broker location and port of the Kafka broker that hosts your Kafka instance. Specify the broker in the form broker-hostname-or-ip:port . For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345".
    
    Parameters:
    
    broker - The broker location and port of the Kafka broker that hosts your Kafka instance. Specify the broker in the form broker-hostname-or-ip:port . For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345".
  - getBroker
```
public String getBroker()
```
    The broker location and port of the Kafka broker that hosts your Kafka instance. Specify the broker in the form broker-hostname-or-ip:port . For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345".
    
    Returns:
    
    The broker location and port of the Kafka broker that hosts your Kafka instance. Specify the broker in the form broker-hostname-or-ip:port . For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345".
  - withBroker
```
public KafkaSettings withBroker(String broker)
```
    The broker location and port of the Kafka broker that hosts your Kafka instance. Specify the broker in the form broker-hostname-or-ip:port . For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345".
    
    Parameters:
    
    broker - The broker location and port of the Kafka broker that hosts your Kafka instance. Specify the broker in the form broker-hostname-or-ip:port . For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTopic
```
public void setTopic(String topic)
```
    The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.
    
    Parameters:
    
    topic - The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.
  - getTopic
```
public String getTopic()
```
    The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.
    
    Returns:
    
    The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.
  - withTopic
```
public KafkaSettings withTopic(String topic)
```
    The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.
    
    Parameters:
    
    topic - The topic to which you migrate the data. If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMessageFormat
```
public void setMessageFormat(String 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).
    
    Parameters:
    
    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).
    
    See Also:
    
    MessageFormatValue
  - getMessageFormat
```
public String getMessageFormat()
```
    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).
    
    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:
    
    MessageFormatValue
  - withMessageFormat
```
public KafkaSettings withMessageFormat(String 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).
    
    Parameters:
    
    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).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MessageFormatValue
  - withMessageFormat
```
public KafkaSettings withMessageFormat(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).
    
    Parameters:
    
    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).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MessageFormatValue
  - setIncludeTransactionDetails
```
public void setIncludeTransactionDetails(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.
    
    Parameters:
    
    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.
  - getIncludeTransactionDetails
```
public Boolean getIncludeTransactionDetails()
```
    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.
  - withIncludeTransactionDetails
```
public KafkaSettings withIncludeTransactionDetails(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIncludeTransactionDetails
```
public Boolean isIncludeTransactionDetails()
```
    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.
  - setIncludePartitionValue
```
public void setIncludePartitionValue(Boolean includePartitionValue)
```
    Shows the partition value within the Kafka message output, unless the partition type is schema-table-type. The default is false.
    
    Parameters:
    
    includePartitionValue - Shows the partition value within the Kafka message output, unless the partition type is schema-table-type. The default is false.
  - getIncludePartitionValue
```
public Boolean getIncludePartitionValue()
```
    Shows the partition value within the Kafka message output, unless the partition type is schema-table-type. The default is false.
    
    Returns:
    
    Shows the partition value within the Kafka message output, unless the partition type is schema-table-type. The default is false.
  - withIncludePartitionValue
```
public KafkaSettings withIncludePartitionValue(Boolean includePartitionValue)
```
    Shows the partition value within the Kafka message output, unless the partition type is schema-table-type. The default is false.
    
    Parameters:
    
    includePartitionValue - Shows the partition value within the Kafka message output, unless the partition type is schema-table-type. The default is false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIncludePartitionValue
```
public Boolean isIncludePartitionValue()
```
    Shows the partition value within the Kafka message output, unless the partition type is schema-table-type. The default is false.
    
    Returns:
    
    Shows the partition value within the Kafka message output, unless the partition type is schema-table-type. The default is false.
  - setPartitionIncludeSchemaTable
```
public void setPartitionIncludeSchemaTable(Boolean partitionIncludeSchemaTable)
```
    Prefixes schema and table names to partition values, when the partition type is primary-key-type. Doing this increases data distribution among Kafka partitions. 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 partition, which causes throttling. The default is false.
    
    Parameters:
    
    partitionIncludeSchemaTable - Prefixes schema and table names to partition values, when the partition type is primary-key-type. Doing this increases data distribution among Kafka partitions. 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 partition, which causes throttling. The default is false.
  - getPartitionIncludeSchemaTable
```
public Boolean getPartitionIncludeSchemaTable()
```
    Prefixes schema and table names to partition values, when the partition type is primary-key-type. Doing this increases data distribution among Kafka partitions. 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 partition, 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 Kafka partitions. 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 partition, which causes throttling. The default is false.
  - withPartitionIncludeSchemaTable
```
public KafkaSettings withPartitionIncludeSchemaTable(Boolean partitionIncludeSchemaTable)
```
    Prefixes schema and table names to partition values, when the partition type is primary-key-type. Doing this increases data distribution among Kafka partitions. 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 partition, which causes throttling. The default is false.
    
    Parameters:
    
    partitionIncludeSchemaTable - Prefixes schema and table names to partition values, when the partition type is primary-key-type. Doing this increases data distribution among Kafka partitions. 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 partition, which causes throttling. The default is false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isPartitionIncludeSchemaTable
```
public Boolean isPartitionIncludeSchemaTable()
```
    Prefixes schema and table names to partition values, when the partition type is primary-key-type. Doing this increases data distribution among Kafka partitions. 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 partition, 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 Kafka partitions. 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 partition, which causes throttling. The default is false.
  - setIncludeTableAlterOperations
```
public void setIncludeTableAlterOperations(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.
    
    Parameters:
    
    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.
  - getIncludeTableAlterOperations
```
public Boolean getIncludeTableAlterOperations()
```
    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.
  - withIncludeTableAlterOperations
```
public KafkaSettings withIncludeTableAlterOperations(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIncludeTableAlterOperations
```
public Boolean isIncludeTableAlterOperations()
```
    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.
  - setIncludeControlDetails
```
public void setIncludeControlDetails(Boolean includeControlDetails)
```
    Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false.
    
    Parameters:
    
    includeControlDetails - Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false.
  - getIncludeControlDetails
```
public Boolean getIncludeControlDetails()
```
    Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false.
    
    Returns:
    
    Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false.
  - withIncludeControlDetails
```
public KafkaSettings withIncludeControlDetails(Boolean includeControlDetails)
```
    Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false.
    
    Parameters:
    
    includeControlDetails - Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIncludeControlDetails
```
public Boolean isIncludeControlDetails()
```
    Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false.
    
    Returns:
    
    Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false.
  - setMessageMaxBytes
```
public void setMessageMaxBytes(Integer messageMaxBytes)
```
    The maximum size in bytes for records created on the endpoint The default is 1,000,000.
    
    Parameters:
    
    messageMaxBytes - The maximum size in bytes for records created on the endpoint The default is 1,000,000.
  - getMessageMaxBytes
```
public Integer getMessageMaxBytes()
```
    The maximum size in bytes for records created on the endpoint The default is 1,000,000.
    
    Returns:
    
    The maximum size in bytes for records created on the endpoint The default is 1,000,000.
  - withMessageMaxBytes
```
public KafkaSettings withMessageMaxBytes(Integer messageMaxBytes)
```
    The maximum size in bytes for records created on the endpoint The default is 1,000,000.
    
    Parameters:
    
    messageMaxBytes - The maximum size in bytes for records created on the endpoint The default is 1,000,000.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIncludeNullAndEmpty
```
public void setIncludeNullAndEmpty(Boolean includeNullAndEmpty)
```
    Include NULL and empty columns for records migrated to the endpoint. The default is false.
    
    Parameters:
    
    includeNullAndEmpty - Include NULL and empty columns for records migrated to the endpoint. The default is false.
  - getIncludeNullAndEmpty
```
public Boolean getIncludeNullAndEmpty()
```
    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.
  - withIncludeNullAndEmpty
```
public KafkaSettings withIncludeNullAndEmpty(Boolean includeNullAndEmpty)
```
    Include NULL and empty columns for records migrated to the endpoint. The default is false.
    
    Parameters:
    
    includeNullAndEmpty - Include NULL and empty columns for records migrated to the endpoint. The default is false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isIncludeNullAndEmpty
```
public Boolean isIncludeNullAndEmpty()
```
    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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public KafkaSettings clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class KafkaSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KafkaSettings

Method Detail

setBroker

getBroker

withBroker

setTopic

getTopic

withTopic

setMessageFormat

getMessageFormat

withMessageFormat

withMessageFormat

setIncludeTransactionDetails

getIncludeTransactionDetails

withIncludeTransactionDetails

isIncludeTransactionDetails

setIncludePartitionValue

getIncludePartitionValue

withIncludePartitionValue

isIncludePartitionValue

setPartitionIncludeSchemaTable

getPartitionIncludeSchemaTable

withPartitionIncludeSchemaTable

isPartitionIncludeSchemaTable

setIncludeTableAlterOperations

getIncludeTableAlterOperations

withIncludeTableAlterOperations

isIncludeTableAlterOperations

setIncludeControlDetails

getIncludeControlDetails

withIncludeControlDetails

isIncludeControlDetails

setMessageMaxBytes

getMessageMaxBytes

withMessageMaxBytes

setIncludeNullAndEmpty

getIncludeNullAndEmpty

withIncludeNullAndEmpty

isIncludeNullAndEmpty

toString

equals

hashCode

clone

marshall