Package io.deephaven.kafka.protobuf

Class ProtobufConsumeOptions

java.lang.Object

io.deephaven.kafka.protobuf.ProtobufConsumeOptions

@Immutable
public abstract class ProtobufConsumeOptions
extends Object

The kafka protobuf options. This will get the protobuf descriptor according to the descriptorProvider() and create message parsing functions according to ProtobufDescriptorParser.parse(Descriptor, ProtobufDescriptorParserOptions).

See Also:

• KafkaTools.Consume.protobufSpec(ProtobufConsumeOptions)
• kafka protobuf serdes

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ProtobufConsumeOptions.Builder
static interface	ProtobufConsumeOptions.FieldPathToColumnName

Constructor Summary

Constructors

Constructor	Description
ProtobufConsumeOptions()

Method Summary

Modifier and Type	Method	Description
static ProtobufConsumeOptions.Builder	builder()	The builder.
abstract DescriptorProvider	descriptorProvider()	The descriptor provider.
static ColumnName	joinNamePathWithUnderscore(FieldPath path, int indexOccurrence)	Joins the name paths with underscores, appending indexOccurrence + 1 if indexOccurrence != 0.
ProtobufDescriptorParserOptions	parserOptions()	The descriptor parsing options.
ProtobufConsumeOptions.FieldPathToColumnName	pathToColumnName()	The function to turn field paths into column names.
Protocol	protocol()	The protocol for decoding the payload.

Methods inherited from class java.lang.Object

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

Constructor Details

ProtobufConsumeOptions

public ProtobufConsumeOptions()

Method Details

builder

public static ProtobufConsumeOptions.Builder builder()

The builder.

Returns:

the builder

joinNamePathWithUnderscore

public static ColumnName joinNamePathWithUnderscore(FieldPath path,
 int indexOccurrence)

Joins the name paths with underscores, appending indexOccurrence + 1 if indexOccurrence != 0.

Parameters:

path - the path

indexOccurrence - the number of times this field path has been used

Returns:

the underscore joined path names

descriptorProvider

public abstract DescriptorProvider descriptorProvider()

The descriptor provider.

Returns:

the descriptor provider

protocol

@Default
public Protocol protocol()

The protocol for decoding the payload. When descriptorProvider() is a DescriptorSchemaRegistry, Protocol.serdes() will be used by default; when descriptorProvider() is a DescriptorMessageClass, Protocol.raw() will be used by default.

Returns:

the payload protocol

parserOptions

@Default
public ProtobufDescriptorParserOptions parserOptions()

The descriptor parsing options. By default, is ProtobufDescriptorParserOptions.defaults().

Returns:

the descriptor parsing options

pathToColumnName

@Default
public ProtobufConsumeOptions.FieldPathToColumnName pathToColumnName()

The function to turn field paths into column names. By default, is the function joinNamePathWithUnderscore(FieldPath, int)}.

Returns:

the function to create column names