Package org.apache.beam.sdk.io.gcp.pubsub

Class PubsubMessageWithAttributesAndMessageIdCoder

java.lang.Object

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

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

org.apache.beam.sdk.io.gcp.pubsub.PubsubMessageWithAttributesAndMessageIdCoder

All Implemented Interfaces:

Serializable

public class PubsubMessageWithAttributesAndMessageIdCoder
extends CustomCoder<PubsubMessage>

A coder for PubsubMessage including attributes and the message id from the PubSub server.

Maintainers should prefer PubsubMessageSchemaCoder over this coder when adding features to PubsubIO.

See Also:

• Serialized Form

Nested Class Summary

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

Coder.Context, Coder.NonDeterministicException

Constructor Summary

Constructors

Constructor	Description
PubsubMessageWithAttributesAndMessageIdCoder()

Method Summary

Modifier and Type	Method	Description
PubsubMessage	decode(InputStream inStream)	Decodes a value of type T from the given input stream in the given context.
void	encode(PubsubMessage value, OutputStream outStream)	Encodes the given value of type T onto the given output stream.
static PubsubMessageWithAttributesAndMessageIdCoder	of()
static Coder<PubsubMessage>	of(TypeDescriptor<PubsubMessage> ignored)

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

getCoderArguments, verifyDeterministic

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

consistentWithEquals, decode, encode, getEncodedElementByteSize, getEncodedElementByteSizeUsingCoder, getEncodedTypeDescriptor, isRegisterByteSizeObserverCheap, registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministic

Methods inherited from class java.lang.Object

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

Constructor Details

PubsubMessageWithAttributesAndMessageIdCoder

public PubsubMessageWithAttributesAndMessageIdCoder()

Method Details

of

public static Coder<PubsubMessage> of(TypeDescriptor<PubsubMessage> ignored)

of

public static PubsubMessageWithAttributesAndMessageIdCoder of()

encode

public void encode(PubsubMessage value,
 OutputStream outStream)
            throws IOException

Description copied from class: Coder

Encodes the given value of type T onto the given output stream. Multiple elements can be encoded next to each other on the output stream, each coder should encode information to know how many bytes to read when decoding. A common approach is to prefix the encoding with the element's encoded length.

Specified by:

encode in class Coder<PubsubMessage>

Throws:

IOException - if writing to the OutputStream fails for some reason

decode

public PubsubMessage decode(InputStream inStream)
                     throws IOException

Description copied from class: Coder

Decodes a value of type T from the given input stream in the given context. Returns the decoded value. Multiple elements can be encoded next to each other on the input stream, each coder should encode information to know how many bytes to read when decoding. A common approach is to prefix the encoding with the element's encoded length.

Specified by:

decode in class Coder<PubsubMessage>

Throws:

IOException - if reading from the InputStream fails for some reason