KafkaSchemaTransformReadConfiguration (Apache Beam 2.42.0)

java.lang.Object
- org.apache.beam.sdk.io.kafka.KafkaSchemaTransformReadConfiguration

```
@Experimental
 @DefaultSchema(value=AutoValueSchema.class)
public abstract class KafkaSchemaTransformReadConfiguration
extends java.lang.Object
```
Configuration for reading from a Kafka topic.
Internal only: This class is actively being worked on, and it will likely change. We provide no backwards compatibility guarantees, and it should not be implemented outside the Beam repository.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`KafkaSchemaTransformReadConfiguration.Builder` Builder for the `KafkaSchemaTransformReadConfiguration`.
`static class`	`KafkaSchemaTransformReadConfiguration.TimestampPolicyConfiguration` A timestamp policy to assign event time for messages in a Kafka partition and watermark for it.
`static class`	`KafkaSchemaTransformReadConfiguration.TopicPartitionConfiguration` A configuration for a `TopicPartition`.

Constructor Summary

Constructors
Constructor and Description

KafkaSchemaTransformReadConfiguration()

Constructors
Constructor and Description
`KafkaSchemaTransformReadConfiguration()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static KafkaSchemaTransformReadConfiguration.Builder`	`builder()` Instantiates a `KafkaSchemaTransformReadConfiguration.Builder` instance.
`abstract java.lang.String`	`getBootstrapServers()` Sets the bootstrap servers for the Kafka consumer.
`abstract java.lang.Boolean`	`getCommitOffsetsInFinalize()` Flags whether finalized offsets are committed to Kafka.
`abstract java.util.Map<java.lang.String,java.lang.Object>`	`getConsumerConfigUpdates()` Configuration updates for the backend main consumer.
`abstract java.lang.Long`	`getCreateTimeMillisecondsMaximumDelay()` Sets the timestamps policy based on KafkaTimestampType.CREATE_TIME timestamp of the records.
`abstract java.lang.Long`	`getDynamicReadMillisecondsDuration()` Configure the KafkaIO to use WatchKafkaTopicPartitionDoFn to detect and emit any new available `TopicPartition` for ReadFromKafkaDoFn to consume during pipeline execution time.
`abstract java.util.Map<java.lang.String,java.lang.Object>`	`getOffsetConsumerConfiguration()` Additional configuration for the backend offset consumer.
`abstract java.lang.Boolean`	`getReadCommitted()` Sets "isolation_level" to "read_committed" in Kafka consumer configuration.
`abstract java.lang.Boolean`	`getReadWithMetadata()` Specifies whether to include metadata when reading from Kafka topic.
`abstract java.lang.Long`	`getStartReadTimeMillisecondsEpoch()` Use timestamp to set up start offset.
`abstract java.lang.Long`	`getStopReadTimeMillisecondsEpoch()` Use timestamp to set up stop offset.
`abstract KafkaSchemaTransformReadConfiguration.TimestampPolicyConfiguration`	`getTimestampPolicy()` A timestamp policy to assign event time for messages in a Kafka partition and watermark for it.
`abstract java.lang.String`	`getTopic()` Sets the topic from which to read.
`abstract java.util.List<KafkaSchemaTransformReadConfiguration.TopicPartitionConfiguration>`	`getTopicPartitions()` Kafka partitions from which to read.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - KafkaSchemaTransformReadConfiguration
```
public KafkaSchemaTransformReadConfiguration()
```
- Method Detail
  - builder
```
public static KafkaSchemaTransformReadConfiguration.Builder builder()
```
    Instantiates a KafkaSchemaTransformReadConfiguration.Builder instance.
  - getBootstrapServers
```
@Nullable
public abstract java.lang.String getBootstrapServers()
```
    Sets the bootstrap servers for the Kafka consumer.
  - getCommitOffsetsInFinalize
```
@Nullable
public abstract java.lang.Boolean getCommitOffsetsInFinalize()
```
    Flags whether finalized offsets are committed to Kafka.
  - getConsumerConfigUpdates
```
@Nullable
public abstract java.util.Map<java.lang.String,java.lang.Object> getConsumerConfigUpdates()
```
    Configuration updates for the backend main consumer.
  - getCreateTimeMillisecondsMaximumDelay
```
@Nullable
public abstract java.lang.Long getCreateTimeMillisecondsMaximumDelay()
```
    Sets the timestamps policy based on KafkaTimestampType.CREATE_TIME timestamp of the records.
  - getDynamicReadMillisecondsDuration
```
@Nullable
public abstract java.lang.Long getDynamicReadMillisecondsDuration()
```
    Configure the KafkaIO to use WatchKafkaTopicPartitionDoFn to detect and emit any new available TopicPartition for ReadFromKafkaDoFn to consume during pipeline execution time.
  - getOffsetConsumerConfiguration
```
@Nullable
public abstract java.util.Map<java.lang.String,java.lang.Object> getOffsetConsumerConfiguration()
```
    Additional configuration for the backend offset consumer.
  - getReadWithMetadata
```
@Nullable
public abstract java.lang.Boolean getReadWithMetadata()
```
    Specifies whether to include metadata when reading from Kafka topic.
  - getReadCommitted
```
@Nullable
public abstract java.lang.Boolean getReadCommitted()
```
    Sets "isolation_level" to "read_committed" in Kafka consumer configuration.
  - getStartReadTimeMillisecondsEpoch
```
@Nullable
public abstract java.lang.Long getStartReadTimeMillisecondsEpoch()
```
    Use timestamp to set up start offset.
  - getStopReadTimeMillisecondsEpoch
```
@Nullable
public abstract java.lang.Long getStopReadTimeMillisecondsEpoch()
```
    Use timestamp to set up stop offset.
  - getTimestampPolicy
```
@Nullable
public abstract KafkaSchemaTransformReadConfiguration.TimestampPolicyConfiguration getTimestampPolicy()
```
    A timestamp policy to assign event time for messages in a Kafka partition and watermark for it.
  - getTopic
```
@Nullable
public abstract java.lang.String getTopic()
```
    Sets the topic from which to read.
  - getTopicPartitions
```
@Nullable
public abstract java.util.List<KafkaSchemaTransformReadConfiguration.TopicPartitionConfiguration> getTopicPartitions()
```
    Kafka partitions from which to read.

Class KafkaSchemaTransformReadConfiguration

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KafkaSchemaTransformReadConfiguration

Method Detail

builder

getBootstrapServers

getCommitOffsetsInFinalize

getConsumerConfigUpdates

getCreateTimeMillisecondsMaximumDelay

getDynamicReadMillisecondsDuration

getOffsetConsumerConfiguration

getReadWithMetadata

getReadCommitted

getStartReadTimeMillisecondsEpoch

getStopReadTimeMillisecondsEpoch

getTimestampPolicy

getTopic

getTopicPartitions