Package org.apache.beam.io.debezium

Class DebeziumIO.ConnectorConfiguration

java.lang.Object

org.apache.beam.io.debezium.DebeziumIO.ConnectorConfiguration

All Implemented Interfaces:

Serializable

Enclosing class:

DebeziumIO

public abstract static class DebeziumIO.ConnectorConfiguration
extends Object
implements Serializable

A POJO describing a Debezium configuration.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ConnectorConfiguration()

Method Summary

Modifier and Type	Method	Description
static DebeziumIO.ConnectorConfiguration	create()	Creates a ConnectorConfiguration.
Map<String,String>	getConfigurationMap()	Configuration Map Getter.
DebeziumIO.ConnectorConfiguration	withConnectionProperties(Map<String,String> connectionProperties)	Sets a custom property to be used within the connection to your database.
DebeziumIO.ConnectorConfiguration	withConnectionProperties(ValueProvider<Map<String,String>> connectionProperties)	Sets a custom property to be used within the connection to your database.
DebeziumIO.ConnectorConfiguration	withConnectionProperty(String key, String value)	Sets a custom property to be used within the connection to your database.
DebeziumIO.ConnectorConfiguration	withConnectorClass(Class<?> connectorClass)	Applies the connectorClass to be used to connect to your database.
DebeziumIO.ConnectorConfiguration	withConnectorClass(ValueProvider<Class<?>> connectorClass)	Sets the connectorClass to be used to connect to your database.
DebeziumIO.ConnectorConfiguration	withHostName(String hostName)	Sets the host name to be used on the database.
DebeziumIO.ConnectorConfiguration	withHostName(ValueProvider<String> hostName)	Sets the host name to be used on the database.
DebeziumIO.ConnectorConfiguration	withPassword(String password)	Sets the password to connect to your database.
DebeziumIO.ConnectorConfiguration	withPassword(ValueProvider<String> password)	Sets the password to connect to your database.
DebeziumIO.ConnectorConfiguration	withPort(String port)	Sets the port on which your database is listening.
DebeziumIO.ConnectorConfiguration	withPort(ValueProvider<String> port)	Sets the port on which your database is listening.
DebeziumIO.ConnectorConfiguration	withSourceConnector(ValueProvider<org.apache.kafka.connect.source.SourceConnector> sourceConnector)
DebeziumIO.ConnectorConfiguration	withSourceConnector(org.apache.kafka.connect.source.SourceConnector sourceConnector)	Sets the SourceConnector to be used.
DebeziumIO.ConnectorConfiguration	withUsername(String username)	Sets the username to connect to your database.
DebeziumIO.ConnectorConfiguration	withUsername(ValueProvider<String> username)	Sets the username to connect to your database.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ConnectorConfiguration

public ConnectorConfiguration()

Method Details

create

public static DebeziumIO.ConnectorConfiguration create()

Creates a ConnectorConfiguration.

Returns:

DebeziumIO.ConnectorConfiguration

withConnectorClass

public DebeziumIO.ConnectorConfiguration withConnectorClass(Class<?> connectorClass)

Applies the connectorClass to be used to connect to your database.

Currently supported connectors are:

• invalid reference

  io.debezium.connector.mysql.MySqlConnector

• invalid reference

  io.debezium.connector.postgresql.PostgresConnector

• invalid reference

  io.debezium.connector.sqlserver.SqlServerConnector

Parameters:

connectorClass - Any of the supported connectors.

Returns:

DebeziumIO.ConnectorConfiguration

withConnectorClass

public DebeziumIO.ConnectorConfiguration withConnectorClass(ValueProvider<Class<?>> connectorClass)

Sets the connectorClass to be used to connect to your database. It cannot be null.

Currently supported connectors are:

• invalid reference

  io.debezium.connector.mysql.MySqlConnector

• invalid reference

  io.debezium.connector.postgresql.PostgresConnector

• invalid reference

  io.debezium.connector.sqlserver.SqlServerConnector

Parameters:

connectorClass - (as ValueProvider)

Returns:

DebeziumIO.ConnectorConfiguration

withHostName

public DebeziumIO.ConnectorConfiguration withHostName(String hostName)

Sets the host name to be used on the database. It cannot be null.

Parameters:

hostName - The hostname of your database.

Returns:

DebeziumIO.ConnectorConfiguration

withHostName

public DebeziumIO.ConnectorConfiguration withHostName(ValueProvider<String> hostName)

Sets the host name to be used on the database. It cannot be null.

Parameters:

hostName - The hostname of your database (as ValueProvider).

Returns:

DebeziumIO.ConnectorConfiguration

withPort

public DebeziumIO.ConnectorConfiguration withPort(String port)

Sets the port on which your database is listening. It cannot be null.

Parameters:

port - The port to be used to connect to your database (as ValueProvider).

Returns:

DebeziumIO.ConnectorConfiguration

withPort

public DebeziumIO.ConnectorConfiguration withPort(ValueProvider<String> port)

Sets the port on which your database is listening. It cannot be null.

Parameters:

port - The port to be used to connect to your database.

Returns:

DebeziumIO.ConnectorConfiguration

withUsername

public DebeziumIO.ConnectorConfiguration withUsername(String username)

Sets the username to connect to your database. It cannot be null.

Parameters:

username - Database username

Returns:

DebeziumIO.ConnectorConfiguration

withUsername

public DebeziumIO.ConnectorConfiguration withUsername(ValueProvider<String> username)

Sets the username to connect to your database. It cannot be null.

Parameters:

username - (as ValueProvider).

Returns:

DebeziumIO.ConnectorConfiguration

withPassword

public DebeziumIO.ConnectorConfiguration withPassword(String password)

Sets the password to connect to your database. It cannot be null.

Parameters:

password - Database password

Returns:

DebeziumIO.ConnectorConfiguration

withPassword

public DebeziumIO.ConnectorConfiguration withPassword(ValueProvider<String> password)

Sets the password to connect to your database. It cannot be null.

Parameters:

password - (as ValueProvider).

Returns:

DebeziumIO.ConnectorConfiguration

withConnectionProperties

public DebeziumIO.ConnectorConfiguration withConnectionProperties(Map<String,String> connectionProperties)

Sets a custom property to be used within the connection to your database.

You may use this to set special configurations such as:

• slot.name
• database.dbname
• database.server.id
• ...

Parameters:

connectionProperties - Properties (Key, Value) Map

Returns:

DebeziumIO.ConnectorConfiguration

withConnectionProperties

public DebeziumIO.ConnectorConfiguration withConnectionProperties(ValueProvider<Map<String,String>> connectionProperties)

Sets a custom property to be used within the connection to your database.

You may use this to set special configurations such as:

• slot.name
• database.dbname
• database.server.id
• ...

Parameters:

connectionProperties - (as ValueProvider).

Returns:

DebeziumIO.ConnectorConfiguration

withConnectionProperty

public DebeziumIO.ConnectorConfiguration withConnectionProperty(String key,
 String value)

Sets a custom property to be used within the connection to your database.

You may use this to set special configurations such as:

• slot.name
• database.dbname
• database.server.id
• ...

Parameters:

key - Property name

value - Property value

Returns:

DebeziumIO.ConnectorConfiguration

withSourceConnector

public DebeziumIO.ConnectorConfiguration withSourceConnector(org.apache.kafka.connect.source.SourceConnector sourceConnector)

Sets the SourceConnector to be used. It cannot be null.

Parameters:

sourceConnector - Any supported connector

Returns:

DebeziumIO.ConnectorConfiguration

withSourceConnector

public DebeziumIO.ConnectorConfiguration withSourceConnector(ValueProvider<org.apache.kafka.connect.source.SourceConnector> sourceConnector)

getConfigurationMap

public Map<String,String> getConfigurationMap()

Configuration Map Getter.

Returns:

Configuration Map.