Package org.apache.kafka.connect.connector

Class ConnectRecord<R extends ConnectRecord<R>>

java.lang.Object

org.apache.kafka.connect.connector.ConnectRecord<R>

Direct Known Subclasses:

SinkRecord, SourceRecord

public abstract class ConnectRecord<R extends ConnectRecord<R>>
extends java.lang.Object

Base class for records containing data to be copied to/from Kafka. This corresponds closely to Kafka's ProducerRecord and ConsumerRecord classes, and holds the data that may be used by both sources and sinks (topic, kafkaPartition, key, value). Although both implementations include a notion of offset, it is not included here because they differ in type.

Constructor Summary

Constructors

Constructor	Description
ConnectRecord(java.lang.String topic, java.lang.Integer kafkaPartition, Schema keySchema, java.lang.Object key, Schema valueSchema, java.lang.Object value, java.lang.Long timestamp)
ConnectRecord(java.lang.String topic, java.lang.Integer kafkaPartition, Schema keySchema, java.lang.Object key, Schema valueSchema, java.lang.Object value, java.lang.Long timestamp, java.lang.Iterable<Header> headers)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
int	hashCode()
Headers	headers()	Get the headers for this record.
java.lang.Integer	kafkaPartition()
java.lang.Object	key()
Schema	keySchema()
abstract R	newRecord(java.lang.String topic, java.lang.Integer kafkaPartition, Schema keySchema, java.lang.Object key, Schema valueSchema, java.lang.Object value, java.lang.Long timestamp)	Create a new record of the same type as itself, with the specified parameter values.
abstract R	newRecord(java.lang.String topic, java.lang.Integer kafkaPartition, Schema keySchema, java.lang.Object key, Schema valueSchema, java.lang.Object value, java.lang.Long timestamp, java.lang.Iterable<Header> headers)	Create a new record of the same type as itself, with the specified parameter values.
java.lang.Long	timestamp()
java.lang.String	topic()
java.lang.String	toString()
java.lang.Object	value()
Schema	valueSchema()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConnectRecord

public ConnectRecord(java.lang.String topic,
                     java.lang.Integer kafkaPartition,
                     Schema keySchema,
                     java.lang.Object key,
                     Schema valueSchema,
                     java.lang.Object value,
                     java.lang.Long timestamp)

ConnectRecord

public ConnectRecord(java.lang.String topic,
                     java.lang.Integer kafkaPartition,
                     Schema keySchema,
                     java.lang.Object key,
                     Schema valueSchema,
                     java.lang.Object value,
                     java.lang.Long timestamp,
                     java.lang.Iterable<Header> headers)

Method Detail

topic

public java.lang.String topic()

kafkaPartition

public java.lang.Integer kafkaPartition()

key

public java.lang.Object key()

keySchema

public Schema keySchema()

value

public java.lang.Object value()

valueSchema

public Schema valueSchema()

timestamp

public java.lang.Long timestamp()

headers

public Headers headers()

Get the headers for this record.

Returns:

the headers; never null

newRecord

public abstract R newRecord(java.lang.String topic,
                            java.lang.Integer kafkaPartition,
                            Schema keySchema,
                            java.lang.Object key,
                            Schema valueSchema,
                            java.lang.Object value,
                            java.lang.Long timestamp)

Create a new record of the same type as itself, with the specified parameter values. All other fields in this record will be copied over to the new record. Since the headers are mutable, the resulting record will have a copy of this record's headers.

Parameters:

topic - the name of the topic; may be null

kafkaPartition - the partition number for the Kafka topic; may be null

keySchema - the schema for the key; may be null

key - the key; may be null

valueSchema - the schema for the value; may be null

value - the value; may be null

timestamp - the timestamp; may be null

Returns:

the new record

newRecord

public abstract R newRecord(java.lang.String topic,
                            java.lang.Integer kafkaPartition,
                            Schema keySchema,
                            java.lang.Object key,
                            Schema valueSchema,
                            java.lang.Object value,
                            java.lang.Long timestamp,
                            java.lang.Iterable<Header> headers)

Create a new record of the same type as itself, with the specified parameter values. All other fields in this record will be copied over to the new record.

Parameters:

topic - the name of the topic; may be null

kafkaPartition - the partition number for the Kafka topic; may be null

keySchema - the schema for the key; may be null

key - the key; may be null

valueSchema - the schema for the value; may be null

value - the value; may be null

timestamp - the timestamp; may be null

headers - the headers; may be null or empty

Returns:

the new record

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object