Skip to content

Commit e6686cf

Browse files
author
Bingqin Zhou
committed
Add java doc.
1 parent fb2bfa8 commit e6686cf

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

kcbq-connector/src/main/java/com/wepay/kafka/connect/bigquery/convert/KafkaDataBuilder.java

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
import java.util.Map;
1010

1111
/**
12-
* Helper class to construct kafka data schema and kafka data record.
12+
* Helper class to construct schema and record for Kafka Data Field.
1313
*/
1414
public class KafkaDataBuilder {
1515

@@ -18,6 +18,12 @@ public class KafkaDataBuilder {
1818
public static final String KAFKA_DATA_OFFSET_FIELD_NAME = "offset";
1919
public static final String KAFKA_DATA_INSERT_TIME_FIELD_NAME = "insertTime";
2020

21+
/**
22+
* Construct schema for Kafka Data Field
23+
*
24+
* @param kafkaDataFieldName The configured name of Kafka Data Field
25+
* @return Field of Kafka Data, with definitions of kafka topic, partition, offset, and insertTime.
26+
*/
2127
public static Field buildKafkaDataField(String kafkaDataFieldName) {
2228
Field topicField = com.google.cloud.bigquery.Field.of(KAFKA_DATA_TOPIC_FIELD_NAME, LegacySQLTypeName.STRING);
2329
Field partitionField = com.google.cloud.bigquery.Field.of(KAFKA_DATA_PARTITION_FIELD_NAME, LegacySQLTypeName.INTEGER);
@@ -32,6 +38,12 @@ public static Field buildKafkaDataField(String kafkaDataFieldName) {
3238
.setMode(com.google.cloud.bigquery.Field.Mode.NULLABLE).build();
3339
}
3440

41+
/**
42+
* Construct a map of Kafka Data record
43+
*
44+
* @param kafkaConnectRecord Kafka sink record to build kafka data from.
45+
* @return HashMap which contains the values of kafka topic, partition, offset, and insertTime.
46+
*/
3547
public static Map<String, Object> buildKafkaDataRecord(SinkRecord kafkaConnectRecord) {
3648
HashMap<String, Object> kafkaData = new HashMap<>();
3749
kafkaData.put(KAFKA_DATA_TOPIC_FIELD_NAME, kafkaConnectRecord.topic());

kcbq-connector/src/main/java/com/wepay/kafka/connect/bigquery/convert/KafkaSchemaRecordType.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
package com.wepay.kafka.connect.bigquery.convert;
22

33

4+
/**
5+
* Enum class for Kafka schema or record type, either value or key.
6+
*/
47
public enum KafkaSchemaRecordType {
58
VALUE("value"),
69
KEY("key");

0 commit comments

Comments
 (0)