Package org.apache.beam.sdk.io.splunk
Class SplunkEventCoder
java.lang.Object
- All Implemented Interfaces:
Serializable
A
Coder
for SplunkEvent
objects.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.beam.sdk.coders.Coder
Coder.Context, Coder.NonDeterministicException
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiondecode
(InputStream in) Decodes a value of typeT
from the given input stream in the given context.void
encode
(SplunkEvent value, OutputStream out) Encodes the given value of typeT
onto the given output stream.static CoderProvider
Returns theTypeDescriptor
for the type encoded.static SplunkEventCoder
of()
void
ThrowCoder.NonDeterministicException
if the coding is not deterministic.Methods inherited from class org.apache.beam.sdk.coders.AtomicCoder
equals, getCoderArguments, getComponents, hashCode
Methods inherited from class org.apache.beam.sdk.coders.StructuredCoder
toString
Methods inherited from class org.apache.beam.sdk.coders.Coder
consistentWithEquals, decode, encode, getEncodedElementByteSize, getEncodedElementByteSizeUsingCoder, isRegisterByteSizeObserverCheap, registerByteSizeObserver, structuralValue, verifyDeterministic, verifyDeterministic
-
Constructor Details
-
SplunkEventCoder
public SplunkEventCoder()
-
-
Method Details
-
of
-
getCoderProvider
-
encode
Description copied from class:Coder
Encodes the given value of typeT
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 classCoder<SplunkEvent>
- Throws:
IOException
- if writing to theOutputStream
fails for some reason
-
decode
Description copied from class:Coder
Decodes a value of typeT
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 classCoder<SplunkEvent>
- Throws:
CoderException
- if the value could not be decoded for some reasonIOException
- if reading from theInputStream
fails for some reason
-
getEncodedTypeDescriptor
Description copied from class:Coder
Returns theTypeDescriptor
for the type encoded.- Overrides:
getEncodedTypeDescriptor
in classCoder<SplunkEvent>
-
verifyDeterministic
Description copied from class:AtomicCoder
ThrowCoder.NonDeterministicException
if the coding is not deterministic.In order for a
Coder
to be considered deterministic, the following must be true:- two values that compare as equal (via
Object.equals()
orComparable.compareTo()
, if supported) have the same encoding. - the
Coder
always produces a canonical encoding, which is the same for an instance of an object even if produced on different computers at different times.
Unless overridden, does not throw. An
AtomicCoder
is presumed to be deterministic- Overrides:
verifyDeterministic
in classAtomicCoder<SplunkEvent>
- Throws:
Coder.NonDeterministicException
- if overridden to indicate that this subclass ofAtomicCoder
is not deterministic
- two values that compare as equal (via
-