org.apache.beam.sdk.extensions.protobuf

Class DynamicProtoCoder

java.lang.Object

org.apache.beam.sdk.coders.Coder<T>

org.apache.beam.sdk.coders.CustomCoder<T>

org.apache.beam.sdk.extensions.protobuf.ProtoCoder<com.google.protobuf.DynamicMessage>

org.apache.beam.sdk.extensions.protobuf.DynamicProtoCoder

All Implemented Interfaces:

java.io.Serializable

public class DynamicProtoCoder
extends ProtoCoder<com.google.protobuf.DynamicMessage>

A Coder using Google Protocol Buffers binary format. DynamicProtoCoder supports both Protocol Buffers syntax versions 2 and 3.

To learn more about Protocol Buffers, visit: https://developers.google.com/protocol-buffers

DynamicProtoCoder is not registered in the global CoderRegistry as the descriptor is required to create the coder.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.beam.sdk.coders.Coder

Coder.Context, Coder.NonDeterministicException

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Method Summary

Modifier and Type	Method and Description
boolean	equals(@Nullable java.lang.Object other)
static CoderProvider	getCoderProvider() Returns a CoderProvider which uses the DynamicProtoCoder for proto messages.
protected com.google.protobuf.Parser<com.google.protobuf.DynamicMessage>	getParser() Get the memoized Parser, possibly initializing it lazily.
int	hashCode()
static DynamicProtoCoder	of(com.google.protobuf.Descriptors.Descriptor protoMessageDescriptor) Returns a DynamicProtoCoder for the Protocol Buffers DynamicMessage for the given Descriptors.Descriptor.
static DynamicProtoCoder	of(ProtoDomain domain, com.google.protobuf.Descriptors.Descriptor protoMessageDescriptor) Returns a DynamicProtoCoder for the Protocol Buffers DynamicMessage for the given Descriptors.Descriptor.
static DynamicProtoCoder	of(ProtoDomain domain, java.lang.String messageName) Returns a DynamicProtoCoder for the Protocol Buffers DynamicMessage for the given message name in a ProtoDomain.
DynamicProtoCoder	withExtensionsFrom(java.lang.Iterable<java.lang.Class<?>> moreExtensionHosts) Returns a DynamicProtoCoder like this one, but with the extensions from the given classes registered.

Methods inherited from class org.apache.beam.sdk.extensions.protobuf.ProtoCoder

decode, decode, encode, encode, getExtensionHosts, getExtensionRegistry, getMessageType, of, of, verifyDeterministic, withExtensionsFrom

Methods inherited from class org.apache.beam.sdk.coders.CustomCoder

getCoderArguments

Methods inherited from class org.apache.beam.sdk.coders.Coder

consistentWithEquals, getEncodedElementByteSize, getEncodedTypeDescriptor, isRegisterByteSizeObserverCheap, registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Method Detail

of

public static DynamicProtoCoder of(com.google.protobuf.Descriptors.Descriptor protoMessageDescriptor)

Returns a DynamicProtoCoder for the Protocol Buffers DynamicMessage for the given Descriptors.Descriptor.

of

public static DynamicProtoCoder of(ProtoDomain domain,
                                   com.google.protobuf.Descriptors.Descriptor protoMessageDescriptor)

Returns a DynamicProtoCoder for the Protocol Buffers DynamicMessage for the given Descriptors.Descriptor. The message descriptor should be part of the provided ProtoDomain, this will ensure object equality within messages from the same domain.

of

public static DynamicProtoCoder of(ProtoDomain domain,
                                   java.lang.String messageName)

Returns a DynamicProtoCoder for the Protocol Buffers DynamicMessage for the given message name in a ProtoDomain. The message descriptor should be part of the provided * ProtoDomain, this will ensure object equality within messages from the same domain.

withExtensionsFrom

public DynamicProtoCoder withExtensionsFrom(java.lang.Iterable<java.lang.Class<?>> moreExtensionHosts)

Returns a DynamicProtoCoder like this one, but with the extensions from the given classes registered.

Each of the extension host classes must be an class automatically generated by the Protocol Buffers compiler, protoc, that contains messages.

Does not modify this object.

Overrides:

withExtensionsFrom in class ProtoCoder<com.google.protobuf.DynamicMessage>

equals

public boolean equals(@Nullable java.lang.Object other)

Overrides:

equals in class ProtoCoder<com.google.protobuf.DynamicMessage>

hashCode

public int hashCode()

Overrides:

hashCode in class ProtoCoder<com.google.protobuf.DynamicMessage>

getParser

protected com.google.protobuf.Parser<com.google.protobuf.DynamicMessage> getParser()

Get the memoized Parser, possibly initializing it lazily.

Overrides:

getParser in class ProtoCoder<com.google.protobuf.DynamicMessage>

getCoderProvider

public static CoderProvider getCoderProvider()

Returns a CoderProvider which uses the DynamicProtoCoder for proto messages.

This method is invoked reflectively from DefaultCoder.