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()` A comma-separated list of one or more broker locations in your Kafka cluster that host 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`	`getNoHexPrefix()` Set this optional parameter to `true` to avoid adding a '0x' prefix to raw data in hexadecimal format.
`Boolean`	`getPartitionIncludeSchemaTable()` Prefixes schema and table names to partition values, when the partition type is `primary-key-type`.
`String`	`getSaslMechanism()` For SASL/SSL authentication, DMS supports the `SCRAM-SHA-512` mechanism by default.
`String`	`getSaslPassword()` The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
`String`	`getSaslUsername()` The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
`String`	`getSecurityProtocol()` Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS).
`String`	`getSslCaCertificateArn()` The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint.
`String`	`getSslClientCertificateArn()` The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
`String`	`getSslClientKeyArn()` The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
`String`	`getSslClientKeyPassword()` The password for the client private key used to securely connect to a Kafka target endpoint.
`String`	`getSslEndpointIdentificationAlgorithm()` Sets hostname verification for the certificate.
`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`	`isNoHexPrefix()` Set this optional parameter to `true` to avoid adding a '0x' prefix to raw data in hexadecimal format.
`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)` A comma-separated list of one or more broker locations in your Kafka cluster that host 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`	`setNoHexPrefix(Boolean noHexPrefix)` Set this optional parameter to `true` to avoid adding a '0x' prefix to raw data in hexadecimal format.
`void`	`setPartitionIncludeSchemaTable(Boolean partitionIncludeSchemaTable)` Prefixes schema and table names to partition values, when the partition type is `primary-key-type`.
`void`	`setSaslMechanism(String saslMechanism)` For SASL/SSL authentication, DMS supports the `SCRAM-SHA-512` mechanism by default.
`void`	`setSaslPassword(String saslPassword)` The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
`void`	`setSaslUsername(String saslUsername)` The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
`void`	`setSecurityProtocol(String securityProtocol)` Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS).
`void`	`setSslCaCertificateArn(String sslCaCertificateArn)` The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint.
`void`	`setSslClientCertificateArn(String sslClientCertificateArn)` The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
`void`	`setSslClientKeyArn(String sslClientKeyArn)` The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
`void`	`setSslClientKeyPassword(String sslClientKeyPassword)` The password for the client private key used to securely connect to a Kafka target endpoint.
`void`	`setSslEndpointIdentificationAlgorithm(String sslEndpointIdentificationAlgorithm)` Sets hostname verification for the certificate.
`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)` A comma-separated list of one or more broker locations in your Kafka cluster that host 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`	`withNoHexPrefix(Boolean noHexPrefix)` Set this optional parameter to `true` to avoid adding a '0x' prefix to raw data in hexadecimal format.
`KafkaSettings`	`withPartitionIncludeSchemaTable(Boolean partitionIncludeSchemaTable)` Prefixes schema and table names to partition values, when the partition type is `primary-key-type`.
`KafkaSettings`	`withSaslMechanism(KafkaSaslMechanism saslMechanism)` For SASL/SSL authentication, DMS supports the `SCRAM-SHA-512` mechanism by default.
`KafkaSettings`	`withSaslMechanism(String saslMechanism)` For SASL/SSL authentication, DMS supports the `SCRAM-SHA-512` mechanism by default.
`KafkaSettings`	`withSaslPassword(String saslPassword)` The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
`KafkaSettings`	`withSaslUsername(String saslUsername)` The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
`KafkaSettings`	`withSecurityProtocol(KafkaSecurityProtocol securityProtocol)` Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS).
`KafkaSettings`	`withSecurityProtocol(String securityProtocol)` Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS).
`KafkaSettings`	`withSslCaCertificateArn(String sslCaCertificateArn)` The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint.
`KafkaSettings`	`withSslClientCertificateArn(String sslClientCertificateArn)` The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
`KafkaSettings`	`withSslClientKeyArn(String sslClientKeyArn)` The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
`KafkaSettings`	`withSslClientKeyPassword(String sslClientKeyPassword)` The password for the client private key used to securely connect to a Kafka target endpoint.
`KafkaSettings`	`withSslEndpointIdentificationAlgorithm(KafkaSslEndpointIdentificationAlgorithm sslEndpointIdentificationAlgorithm)` Sets hostname verification for the certificate.
`KafkaSettings`	`withSslEndpointIdentificationAlgorithm(String sslEndpointIdentificationAlgorithm)` Sets hostname verification for the certificate.
`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)
```
    A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance. Specify each broker location in the form broker-hostname-or-ip:port . For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345". For more information and examples of specifying a list of broker locations, see Using Apache Kafka as a target for Database Migration Service in the Database Migration Service User Guide.
    
    Parameters:
    
    broker - A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance. Specify each broker location in the form broker-hostname-or-ip:port . For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345". For more information and examples of specifying a list of broker locations, see Using Apache Kafka as a target for Database Migration Service in the Database Migration Service User Guide.
  - getBroker
```
public String getBroker()
```
    A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance. Specify each broker location in the form broker-hostname-or-ip:port . For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345". For more information and examples of specifying a list of broker locations, see Using Apache Kafka as a target for Database Migration Service in the Database Migration Service User Guide.
    
    Returns:
    
    A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance. Specify each broker location in the form broker-hostname-or-ip:port . For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345". For more information and examples of specifying a list of broker locations, see Using Apache Kafka as a target for Database Migration Service in the Database Migration Service User Guide.
  - withBroker
```
public KafkaSettings withBroker(String broker)
```
    A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance. Specify each broker location in the form broker-hostname-or-ip:port . For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345". For more information and examples of specifying a list of broker locations, see Using Apache Kafka as a target for Database Migration Service in the Database Migration Service User Guide.
    
    Parameters:
    
    broker - A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance. Specify each broker location in the form broker-hostname-or-ip:port . For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345". For more information and examples of specifying a list of broker locations, see Using Apache Kafka as a target for Database Migration Service in the Database Migration Service User Guide.
    
    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, 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, 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, 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, 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, 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, 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.
  - setSecurityProtocol
```
public void setSecurityProtocol(String securityProtocol)
```
    Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). Options include ssl-encryption, ssl-authentication, and sasl-ssl. sasl-ssl requires SaslUsername and SaslPassword.
    
    Parameters:
    
    securityProtocol - Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). Options include ssl-encryption, ssl-authentication, and sasl-ssl. sasl-ssl requires SaslUsername and SaslPassword.
    
    See Also:
    
    KafkaSecurityProtocol
  - getSecurityProtocol
```
public String getSecurityProtocol()
```
    Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). Options include ssl-encryption, ssl-authentication, and sasl-ssl. sasl-ssl requires SaslUsername and SaslPassword.
    
    Returns:
    
    Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). Options include ssl-encryption, ssl-authentication, and sasl-ssl. sasl-ssl requires SaslUsername and SaslPassword.
    
    See Also:
    
    KafkaSecurityProtocol
  - withSecurityProtocol
```
public KafkaSettings withSecurityProtocol(String securityProtocol)
```
    Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). Options include ssl-encryption, ssl-authentication, and sasl-ssl. sasl-ssl requires SaslUsername and SaslPassword.
    
    Parameters:
    
    securityProtocol - Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). Options include ssl-encryption, ssl-authentication, and sasl-ssl. sasl-ssl requires SaslUsername and SaslPassword.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KafkaSecurityProtocol
  - withSecurityProtocol
```
public KafkaSettings withSecurityProtocol(KafkaSecurityProtocol securityProtocol)
```
    Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). Options include ssl-encryption, ssl-authentication, and sasl-ssl. sasl-ssl requires SaslUsername and SaslPassword.
    
    Parameters:
    
    securityProtocol - Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). Options include ssl-encryption, ssl-authentication, and sasl-ssl. sasl-ssl requires SaslUsername and SaslPassword.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KafkaSecurityProtocol
  - setSslClientCertificateArn
```
public void setSslClientCertificateArn(String sslClientCertificateArn)
```
    The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
    
    Parameters:
    
    sslClientCertificateArn - The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
  - getSslClientCertificateArn
```
public String getSslClientCertificateArn()
```
    The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
  - withSslClientCertificateArn
```
public KafkaSettings withSslClientCertificateArn(String sslClientCertificateArn)
```
    The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
    
    Parameters:
    
    sslClientCertificateArn - The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSslClientKeyArn
```
public void setSslClientKeyArn(String sslClientKeyArn)
```
    The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
    
    Parameters:
    
    sslClientKeyArn - The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
  - getSslClientKeyArn
```
public String getSslClientKeyArn()
```
    The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
  - withSslClientKeyArn
```
public KafkaSettings withSslClientKeyArn(String sslClientKeyArn)
```
    The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
    
    Parameters:
    
    sslClientKeyArn - The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSslClientKeyPassword
```
public void setSslClientKeyPassword(String sslClientKeyPassword)
```
    The password for the client private key used to securely connect to a Kafka target endpoint.
    
    Parameters:
    
    sslClientKeyPassword - The password for the client private key used to securely connect to a Kafka target endpoint.
  - getSslClientKeyPassword
```
public String getSslClientKeyPassword()
```
    The password for the client private key used to securely connect to a Kafka target endpoint.
    
    Returns:
    
    The password for the client private key used to securely connect to a Kafka target endpoint.
  - withSslClientKeyPassword
```
public KafkaSettings withSslClientKeyPassword(String sslClientKeyPassword)
```
    The password for the client private key used to securely connect to a Kafka target endpoint.
    
    Parameters:
    
    sslClientKeyPassword - The password for the client private key used to securely connect to a Kafka target endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSslCaCertificateArn
```
public void setSslCaCertificateArn(String sslCaCertificateArn)
```
    The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint.
    
    Parameters:
    
    sslCaCertificateArn - The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint.
  - getSslCaCertificateArn
```
public String getSslCaCertificateArn()
```
    The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint.
  - withSslCaCertificateArn
```
public KafkaSettings withSslCaCertificateArn(String sslCaCertificateArn)
```
    The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint.
    
    Parameters:
    
    sslCaCertificateArn - The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSaslUsername
```
public void setSaslUsername(String saslUsername)
```
    The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    
    Parameters:
    
    saslUsername - The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
  - getSaslUsername
```
public String getSaslUsername()
```
    The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    
    Returns:
    
    The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
  - withSaslUsername
```
public KafkaSettings withSaslUsername(String saslUsername)
```
    The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    
    Parameters:
    
    saslUsername - The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSaslPassword
```
public void setSaslPassword(String saslPassword)
```
    The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    
    Parameters:
    
    saslPassword - The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
  - getSaslPassword
```
public String getSaslPassword()
```
    The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    
    Returns:
    
    The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
  - withSaslPassword
```
public KafkaSettings withSaslPassword(String saslPassword)
```
    The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    
    Parameters:
    
    saslPassword - The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNoHexPrefix
```
public void setNoHexPrefix(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 a Kafka target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.
    
    Parameters:
    
    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 a Kafka target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.
  - getNoHexPrefix
```
public Boolean getNoHexPrefix()
```
    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 a Kafka 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 a Kafka target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.
  - withNoHexPrefix
```
public KafkaSettings withNoHexPrefix(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 a Kafka target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.
    
    Parameters:
    
    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 a Kafka target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isNoHexPrefix
```
public Boolean isNoHexPrefix()
```
    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 a Kafka 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 a Kafka target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.
  - setSaslMechanism
```
public void setSaslMechanism(String saslMechanism)
```
    For SASL/SSL authentication, DMS supports the SCRAM-SHA-512 mechanism by default. DMS versions 3.5.0 and later also support the PLAIN mechanism. To use the PLAIN mechanism, set this parameter to PLAIN.
    
    Parameters:
    
    saslMechanism - For SASL/SSL authentication, DMS supports the SCRAM-SHA-512 mechanism by default. DMS versions 3.5.0 and later also support the PLAIN mechanism. To use the PLAIN mechanism, set this parameter to PLAIN.
    
    See Also:
    
    KafkaSaslMechanism
  - getSaslMechanism
```
public String getSaslMechanism()
```
    For SASL/SSL authentication, DMS supports the SCRAM-SHA-512 mechanism by default. DMS versions 3.5.0 and later also support the PLAIN mechanism. To use the PLAIN mechanism, set this parameter to PLAIN.
    
    Returns:
    
    For SASL/SSL authentication, DMS supports the SCRAM-SHA-512 mechanism by default. DMS versions 3.5.0 and later also support the PLAIN mechanism. To use the PLAIN mechanism, set this parameter to PLAIN.
    
    See Also:
    
    KafkaSaslMechanism
  - withSaslMechanism
```
public KafkaSettings withSaslMechanism(String saslMechanism)
```
    For SASL/SSL authentication, DMS supports the SCRAM-SHA-512 mechanism by default. DMS versions 3.5.0 and later also support the PLAIN mechanism. To use the PLAIN mechanism, set this parameter to PLAIN.
    
    Parameters:
    
    saslMechanism - For SASL/SSL authentication, DMS supports the SCRAM-SHA-512 mechanism by default. DMS versions 3.5.0 and later also support the PLAIN mechanism. To use the PLAIN mechanism, set this parameter to PLAIN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KafkaSaslMechanism
  - withSaslMechanism
```
public KafkaSettings withSaslMechanism(KafkaSaslMechanism saslMechanism)
```
    For SASL/SSL authentication, DMS supports the SCRAM-SHA-512 mechanism by default. DMS versions 3.5.0 and later also support the PLAIN mechanism. To use the PLAIN mechanism, set this parameter to PLAIN.
    
    Parameters:
    
    saslMechanism - For SASL/SSL authentication, DMS supports the SCRAM-SHA-512 mechanism by default. DMS versions 3.5.0 and later also support the PLAIN mechanism. To use the PLAIN mechanism, set this parameter to PLAIN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KafkaSaslMechanism
  - setSslEndpointIdentificationAlgorithm
```
public void setSslEndpointIdentificationAlgorithm(String sslEndpointIdentificationAlgorithm)
```
    Sets hostname verification for the certificate. This setting is supported in DMS version 3.5.1 and later.
    
    Parameters:
    
    sslEndpointIdentificationAlgorithm - Sets hostname verification for the certificate. This setting is supported in DMS version 3.5.1 and later.
    
    See Also:
    
    KafkaSslEndpointIdentificationAlgorithm
  - getSslEndpointIdentificationAlgorithm
```
public String getSslEndpointIdentificationAlgorithm()
```
    Sets hostname verification for the certificate. This setting is supported in DMS version 3.5.1 and later.
    
    Returns:
    
    Sets hostname verification for the certificate. This setting is supported in DMS version 3.5.1 and later.
    
    See Also:
    
    KafkaSslEndpointIdentificationAlgorithm
  - withSslEndpointIdentificationAlgorithm
```
public KafkaSettings withSslEndpointIdentificationAlgorithm(String sslEndpointIdentificationAlgorithm)
```
    Sets hostname verification for the certificate. This setting is supported in DMS version 3.5.1 and later.
    
    Parameters:
    
    sslEndpointIdentificationAlgorithm - Sets hostname verification for the certificate. This setting is supported in DMS version 3.5.1 and later.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KafkaSslEndpointIdentificationAlgorithm
  - withSslEndpointIdentificationAlgorithm
```
public KafkaSettings withSslEndpointIdentificationAlgorithm(KafkaSslEndpointIdentificationAlgorithm sslEndpointIdentificationAlgorithm)
```
    Sets hostname verification for the certificate. This setting is supported in DMS version 3.5.1 and later.
    
    Parameters:
    
    sslEndpointIdentificationAlgorithm - Sets hostname verification for the certificate. This setting is supported in DMS version 3.5.1 and later.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KafkaSslEndpointIdentificationAlgorithm
  - 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.

AWS SDK for Java 1.x API Reference - 1.12.771

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

setSecurityProtocol

getSecurityProtocol

withSecurityProtocol

withSecurityProtocol

setSslClientCertificateArn

getSslClientCertificateArn

withSslClientCertificateArn

setSslClientKeyArn

getSslClientKeyArn

withSslClientKeyArn

setSslClientKeyPassword

getSslClientKeyPassword

withSslClientKeyPassword

setSslCaCertificateArn

getSslCaCertificateArn

withSslCaCertificateArn

setSaslUsername

getSaslUsername

withSaslUsername

setSaslPassword

getSaslPassword

withSaslPassword

setNoHexPrefix

getNoHexPrefix

withNoHexPrefix

isNoHexPrefix

setSaslMechanism

getSaslMechanism

withSaslMechanism

withSaslMechanism

setSslEndpointIdentificationAlgorithm

getSslEndpointIdentificationAlgorithm

withSslEndpointIdentificationAlgorithm

withSslEndpointIdentificationAlgorithm

toString