org.apache.beam.sdk.values

Class BeamRecordType

java.lang.Object

org.apache.beam.sdk.values.BeamRecordType

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BeamRecordSqlType

@Experimental
public class BeamRecordType
extends java.lang.Object
implements java.io.Serializable

BeamRecordType describes the fields in BeamRecord, extra checking can be added by overwriting validateValueType(int, Object).

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BeamRecordType(java.util.List<java.lang.String> fieldNames, java.util.List<Coder> fieldCoders) Create a BeamRecordType with a name and Coder for each field.

Method Summary

Modifier and Type	Method and Description
int	findIndexOfField(java.lang.String fieldName) Find the index of a given field.
int	getFieldCount() Return the count of fields.
java.lang.String	getFieldNameByIndex(int index) Return the name of field by index.
java.util.List<java.lang.String>	getFieldNames() Returns an immutable list of field names.
BeamRecordCoder	getRecordCoder() Return the coder for BeamRecord, which wraps fieldCoders for each field.
java.lang.String	toString()
void	validateValueType(int index, java.lang.Object fieldValue) Validate input fieldValue for a field.

Methods inherited from class java.lang.Object

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

Constructor Detail

BeamRecordType

public BeamRecordType(java.util.List<java.lang.String> fieldNames,
                      java.util.List<Coder> fieldCoders)

Create a BeamRecordType with a name and Coder for each field.

Method Detail

validateValueType

public void validateValueType(int index,
                              java.lang.Object fieldValue)
                       throws java.lang.IllegalArgumentException

Validate input fieldValue for a field.

Throws:

java.lang.IllegalArgumentException - throw exception when the validation fails.

getRecordCoder

public BeamRecordCoder getRecordCoder()

Return the coder for BeamRecord, which wraps fieldCoders for each field.

getFieldNames

public java.util.List<java.lang.String> getFieldNames()

Returns an immutable list of field names.

getFieldNameByIndex

public java.lang.String getFieldNameByIndex(int index)

Return the name of field by index.

findIndexOfField

public int findIndexOfField(java.lang.String fieldName)

Find the index of a given field.

getFieldCount

public int getFieldCount()

Return the count of fields.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object