Documentation

Additional options for streaming.

See: newKafkaStreamingSourceOptions smart constructor.

Create a value of KafkaStreamingSourceOptions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:assign:KafkaStreamingSourceOptions', kafkaStreamingSourceOptions_assign - The specific TopicPartitions to consume. You must specify at least one of "topicName", "assign" or "subscribePattern".

$sel:bootstrapServers:KafkaStreamingSourceOptions', kafkaStreamingSourceOptions_bootstrapServers - A list of bootstrap server URLs, for example, as b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094. This option must be specified in the API call or defined in the table metadata in the Data Catalog.

$sel:classification:KafkaStreamingSourceOptions', kafkaStreamingSourceOptions_classification - An optional classification.

$sel:connectionName:KafkaStreamingSourceOptions', kafkaStreamingSourceOptions_connectionName - The name of the connection.

$sel:delimiter:KafkaStreamingSourceOptions', kafkaStreamingSourceOptions_delimiter - Specifies the delimiter character.

$sel:endingOffsets:KafkaStreamingSourceOptions', kafkaStreamingSourceOptions_endingOffsets - The end point when a batch query is ended. Possible values are either "latest" or a JSON string that specifies an ending offset for each TopicPartition.

$sel:maxOffsetsPerTrigger:KafkaStreamingSourceOptions', kafkaStreamingSourceOptions_maxOffsetsPerTrigger - The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across topicPartitions of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.

$sel:minPartitions:KafkaStreamingSourceOptions', kafkaStreamingSourceOptions_minPartitions - The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.

$sel:numRetries:KafkaStreamingSourceOptions', kafkaStreamingSourceOptions_numRetries - The number of times to retry before failing to fetch Kafka offsets. The default value is 3.

$sel:pollTimeoutMs:KafkaStreamingSourceOptions', kafkaStreamingSourceOptions_pollTimeoutMs - The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is 512.

$sel:retryIntervalMs:KafkaStreamingSourceOptions', kafkaStreamingSourceOptions_retryIntervalMs - The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is 10.

$sel:securityProtocol:KafkaStreamingSourceOptions', kafkaStreamingSourceOptions_securityProtocol - The protocol used to communicate with brokers. The possible values are "SSL" or "PLAINTEXT".

$sel:startingOffsets:KafkaStreamingSourceOptions', kafkaStreamingSourceOptions_startingOffsets - The starting position in the Kafka topic to read data from. The possible values are "earliest" or "latest". The default value is "latest".

$sel:subscribePattern:KafkaStreamingSourceOptions', kafkaStreamingSourceOptions_subscribePattern - A Java regex string that identifies the topic list to subscribe to. You must specify at least one of "topicName", "assign" or "subscribePattern".

$sel:topicName:KafkaStreamingSourceOptions', kafkaStreamingSourceOptions_topicName - The topic name as specified in Apache Kafka. You must specify at least one of "topicName", "assign" or "subscribePattern".

The specific TopicPartitions to consume. You must specify at least one of "topicName", "assign" or "subscribePattern".

A list of bootstrap server URLs, for example, as b-1.vpc-test-2.o4q88o.c6.kafka.us-east-1.amazonaws.com:9094. This option must be specified in the API call or defined in the table metadata in the Data Catalog.

An optional classification.

The name of the connection.

Specifies the delimiter character.

The end point when a batch query is ended. Possible values are either "latest" or a JSON string that specifies an ending offset for each TopicPartition.

The rate limit on the maximum number of offsets that are processed per trigger interval. The specified total number of offsets is proportionally split across topicPartitions of different volumes. The default value is null, which means that the consumer reads all offsets until the known latest offset.

The desired minimum number of partitions to read from Kafka. The default value is null, which means that the number of spark partitions is equal to the number of Kafka partitions.

The number of times to retry before failing to fetch Kafka offsets. The default value is 3.

The timeout in milliseconds to poll data from Kafka in Spark job executors. The default value is 512.

The time in milliseconds to wait before retrying to fetch Kafka offsets. The default value is 10.

The protocol used to communicate with brokers. The possible values are "SSL" or "PLAINTEXT".

The starting position in the Kafka topic to read data from. The possible values are "earliest" or "latest". The default value is "latest".

A Java regex string that identifies the topic list to subscribe to. You must specify at least one of "topicName", "assign" or "subscribePattern".

The topic name as specified in Apache Kafka. You must specify at least one of "topicName", "assign" or "subscribePattern".