Package org.apache.beam.sdk.values

Class Row

java.lang.Object

org.apache.beam.sdk.values.Row

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

RowWithGetters, RowWithStorage

public abstract class Row
extends Object
implements Serializable

Row is an immutable tuple-like schema to represent one element in a PCollection. The fields are described with a Schema.

Schema contains the names and types for each field.

There are several ways to build a new Row object. To build a row from scratch using a schema object, withSchema(org.apache.beam.sdk.schemas.Schema) can be used. Schema fields can be specified by name, and nested fields can be specified using the field selection syntax. For example:

 Row row = Row.withSchema(schema)
              .withFieldValue("userId", "user1)
              .withFieldValue("location.city", "seattle")
              .withFieldValue("location.state", "wa")
              .build();
 

The fromRow(org.apache.beam.sdk.values.Row) builder can be used to base a row off of another row. The builder can be used to specify values for specific fields, and all the remaining values will be taken from the original row. For example, the following produces a row identical to the above row except for the location.city field.

 Row modifiedRow =
     Row.fromRow(row)
        .withFieldValue("location.city", "tacoma")
        .build();
 

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Row.Builder	Builder for Row.
static class	Row.Equals
static class	Row.FieldValueBuilder	Builder for Row that bases a row on another row.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object o)
static Row.FieldValueBuilder	fromRow(Row row)	Creates a row builder based on the specified row.
<T> @Nullable Collection<T>	getArray(int idx)	Get an array value by field index, IllegalStateException is thrown if schema doesn't match.
<T> @Nullable Collection<T>	getArray(String fieldName)	Get an array value by field name, IllegalStateException is thrown if schema doesn't match.
@Nullable Object	getBaseValue(int idx)	Returns the base type for this field.
<T extends @Nullable Object> T	getBaseValue(int idx, Class<T> clazz)	Returns the base type for this field.
@Nullable Object	getBaseValue(String fieldName)	Returns the base type for this field.
<T extends @Nullable Object> T	getBaseValue(String fieldName, Class<T> clazz)	Returns the base type for this field.
List<Object>	getBaseValues()	Return a list of data values.
@Nullable Boolean	getBoolean(int idx)	Get a Boolean value by field index, ClassCastException is thrown if schema doesn't match.
@Nullable Boolean	getBoolean(String fieldName)	Get a Schema.TypeName.BOOLEAN value by field name, IllegalStateException is thrown if schema doesn't match.
@Nullable Byte	getByte(int idx)	Get a Schema.TypeName.BYTE value by field index, ClassCastException is thrown if schema doesn't match.
@Nullable Byte	getByte(String fieldName)	Get a Schema.TypeName.BYTE value by field name, IllegalStateException is thrown if schema doesn't match.
byte @Nullable []	getBytes(int idx)	Get a Schema.TypeName.BYTES value by field index, ClassCastException is thrown if schema doesn't match.
byte @Nullable []	getBytes(String fieldName)	Get a Schema.TypeName.BYTES value by field name, IllegalStateException is thrown if schema doesn't match.
@Nullable ReadableDateTime	getDateTime(int idx)	Get a Schema.TypeName.DATETIME value by field index, IllegalStateException is thrown if schema doesn't match.
@Nullable ReadableDateTime	getDateTime(String fieldName)	Get a Schema.TypeName.DATETIME value by field name, IllegalStateException is thrown if schema doesn't match.
@Nullable BigDecimal	getDecimal(int idx)	Get a BigDecimal value by field index, ClassCastException is thrown if schema doesn't match.
@Nullable BigDecimal	getDecimal(String fieldName)	Get a Schema.TypeName.DECIMAL value by field name, IllegalStateException is thrown if schema doesn't match.
@Nullable Double	getDouble(int idx)	Get a Schema.TypeName.DOUBLE value by field index, ClassCastException is thrown if schema doesn't match.
@Nullable Double	getDouble(String fieldName)	Get a Schema.TypeName.DOUBLE value by field name, IllegalStateException is thrown if schema doesn't match.
abstract int	getFieldCount()	Return the size of data fields.
@Nullable Float	getFloat(int idx)	Get a Schema.TypeName.FLOAT value by field index, ClassCastException is thrown if schema doesn't match.
@Nullable Float	getFloat(String fieldName)	Get a Schema.TypeName.FLOAT value by field name, IllegalStateException is thrown if schema doesn't match.
@Nullable Short	getInt16(int idx)	Get a Schema.TypeName.INT16 value by field index, ClassCastException is thrown if schema doesn't match.
@Nullable Short	getInt16(String fieldName)	Get a Schema.TypeName.INT16 value by field name, IllegalStateException is thrown if schema doesn't match.
@Nullable Integer	getInt32(int idx)	Get a Schema.TypeName.INT32 value by field index, ClassCastException is thrown if schema doesn't match.
@Nullable Integer	getInt32(String fieldName)	Get a Schema.TypeName.INT32 value by field name, IllegalStateException is thrown if schema doesn't match.
@Nullable Long	getInt64(int idx)	Get a Schema.TypeName.INT64 value by field index, ClassCastException is thrown if schema doesn't match.
@Nullable Long	getInt64(String fieldName)	Get a Schema.TypeName.INT64 value by field name, IllegalStateException is thrown if schema doesn't match.
<T> @Nullable Iterable<T>	getIterable(int idx)	Get an iterable value by field index, IllegalStateException is thrown if schema doesn't match.
<T> @Nullable Iterable<T>	getIterable(String fieldName)	Get an iterable value by field name, IllegalStateException is thrown if schema doesn't match.
<T extends @Nullable Object> T	getLogicalTypeValue(int idx, Class<T> clazz)	Returns the Logical Type input type for this field.
<T extends @Nullable Object> T	getLogicalTypeValue(String fieldName, Class<T> clazz)	Returns the Logical Type input type for this field.
<T1, T2> @Nullable Map<T1,T2>	getMap(int idx)	Get a MAP value by field index, IllegalStateException is thrown if schema doesn't match.
<T1, T2> @Nullable Map<T1,T2>	getMap(String fieldName)	Get a MAP value by field name, IllegalStateException is thrown if schema doesn't match.
@Nullable Row	getRow(int idx)	Get a Row value by field index, IllegalStateException is thrown if schema doesn't match.
@Nullable Row	getRow(String fieldName)	Get a Schema.TypeName.ROW value by field name, IllegalStateException is thrown if schema doesn't match.
Schema	getSchema()	Return Schema which describes the fields.
@Nullable String	getString(int idx)	Get a String value by field index, ClassCastException is thrown if schema doesn't match.
@Nullable String	getString(String fieldName)	Get a Schema.TypeName.STRING value by field name, IllegalStateException is thrown if schema doesn't match.
abstract <T extends @Nullable Object> T	getValue(int fieldIdx)	Get value by field index, ClassCastException is thrown if schema doesn't match.
<T extends @Nullable Object> T	getValue(String fieldName)	Get value by field name, ClassCastException is thrown if type doesn't match.
abstract List<@Nullable Object>	getValues()	Return the list of raw unmodified data values to enable 0-copy code.
int	hashCode()
static Row	nullRow(Schema schema)	Creates a new record filled with nulls.
Row	sorted()	Returns an equivalent Row with fields lexicographically sorted by their name.
Row	toCamelCase()	Returns an equivalent Row with `lowerCamelCase` field names.
static <T> Collector<T,List<Object>,Row>	toRow(Schema schema)	Creates a Row from the list of values and getSchema().
Row	toSnakeCase()	Returns an equivalent Row with `snake_case` field names.
String	toString()
String	toString(boolean includeFieldNames)	Convert Row to String.
static Row.Builder	withSchema(Schema schema)	Creates a row builder with specified getSchema().

Methods inherited from class java.lang.Object

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

Method Details

getValue

public abstract <T extends @Nullable Object> T getValue(int fieldIdx)

Get value by field index, ClassCastException is thrown if schema doesn't match.

getFieldCount

public abstract int getFieldCount()

Return the size of data fields.

getValues

public abstract List<@Nullable Object> getValues()

Return the list of raw unmodified data values to enable 0-copy code.

getBaseValues

public List<Object> getBaseValues()

Return a list of data values. Any LogicalType values are returned as base values. *

getValue

public <T extends @Nullable Object> T getValue(String fieldName)

Get value by field name, ClassCastException is thrown if type doesn't match.

getByte

public @Nullable Byte getByte(String fieldName)

Get a Schema.TypeName.BYTE value by field name, IllegalStateException is thrown if schema doesn't match.

getBytes

public byte @Nullable [] getBytes(String fieldName)

Get a Schema.TypeName.BYTES value by field name, IllegalStateException is thrown if schema doesn't match.

getInt16

public @Nullable Short getInt16(String fieldName)

Get a Schema.TypeName.INT16 value by field name, IllegalStateException is thrown if schema doesn't match.

getInt32

public @Nullable Integer getInt32(String fieldName)

Get a Schema.TypeName.INT32 value by field name, IllegalStateException is thrown if schema doesn't match.

getInt64

public @Nullable Long getInt64(String fieldName)

Get a Schema.TypeName.INT64 value by field name, IllegalStateException is thrown if schema doesn't match.

getDecimal

public @Nullable BigDecimal getDecimal(String fieldName)

Get a Schema.TypeName.DECIMAL value by field name, IllegalStateException is thrown if schema doesn't match.

getFloat

public @Nullable Float getFloat(String fieldName)

Get a Schema.TypeName.FLOAT value by field name, IllegalStateException is thrown if schema doesn't match.

getDouble

public @Nullable Double getDouble(String fieldName)

Get a Schema.TypeName.DOUBLE value by field name, IllegalStateException is thrown if schema doesn't match.

getString

public @Nullable String getString(String fieldName)

Get a Schema.TypeName.STRING value by field name, IllegalStateException is thrown if schema doesn't match.

getDateTime

public @Nullable ReadableDateTime getDateTime(String fieldName)

Get a Schema.TypeName.DATETIME value by field name, IllegalStateException is thrown if schema doesn't match.

getBoolean

public @Nullable Boolean getBoolean(String fieldName)

Get a Schema.TypeName.BOOLEAN value by field name, IllegalStateException is thrown if schema doesn't match.

getArray

public <T> @Nullable Collection<T> getArray(String fieldName)

Get an array value by field name, IllegalStateException is thrown if schema doesn't match.

getIterable

public <T> @Nullable Iterable<T> getIterable(String fieldName)

Get an iterable value by field name, IllegalStateException is thrown if schema doesn't match.

getMap

public <T1,
T2> @Nullable Map<T1,T2> getMap(String fieldName)

Get a MAP value by field name, IllegalStateException is thrown if schema doesn't match.

getLogicalTypeValue

public <T extends @Nullable Object> T getLogicalTypeValue(String fieldName,
 Class<T> clazz)

Returns the Logical Type input type for this field. IllegalStateException is thrown if schema doesn't match.

getBaseValue

public <T extends @Nullable Object> T getBaseValue(String fieldName,
 Class<T> clazz)

Returns the base type for this field. If this is a logical type, we convert to the base value. Otherwise the field itself is returned.

getBaseValue

public @Nullable Object getBaseValue(String fieldName)

Returns the base type for this field. If this is a logical type, we convert to the base value. Otherwise the field itself is returned.

getRow

public @Nullable Row getRow(String fieldName)

Get a Schema.TypeName.ROW value by field name, IllegalStateException is thrown if schema doesn't match.

getByte

public @Nullable Byte getByte(int idx)

Get a Schema.TypeName.BYTE value by field index, ClassCastException is thrown if schema doesn't match.

getBytes

public byte @Nullable [] getBytes(int idx)

Get a Schema.TypeName.BYTES value by field index, ClassCastException is thrown if schema doesn't match.

getInt16

public @Nullable Short getInt16(int idx)

Get a Schema.TypeName.INT16 value by field index, ClassCastException is thrown if schema doesn't match.

getInt32

public @Nullable Integer getInt32(int idx)

Get a Schema.TypeName.INT32 value by field index, ClassCastException is thrown if schema doesn't match.

getFloat

public @Nullable Float getFloat(int idx)

Get a Schema.TypeName.FLOAT value by field index, ClassCastException is thrown if schema doesn't match.

getDouble

public @Nullable Double getDouble(int idx)

Get a Schema.TypeName.DOUBLE value by field index, ClassCastException is thrown if schema doesn't match.

getInt64

public @Nullable Long getInt64(int idx)

Get a Schema.TypeName.INT64 value by field index, ClassCastException is thrown if schema doesn't match.

getString

public @Nullable String getString(int idx)

Get a String value by field index, ClassCastException is thrown if schema doesn't match.

getDateTime

public @Nullable ReadableDateTime getDateTime(int idx)

Get a Schema.TypeName.DATETIME value by field index, IllegalStateException is thrown if schema doesn't match.

getDecimal

public @Nullable BigDecimal getDecimal(int idx)

Get a BigDecimal value by field index, ClassCastException is thrown if schema doesn't match.

getBoolean

public @Nullable Boolean getBoolean(int idx)

Get a Boolean value by field index, ClassCastException is thrown if schema doesn't match.

getArray

public <T> @Nullable Collection<T> getArray(int idx)

Get an array value by field index, IllegalStateException is thrown if schema doesn't match.

getIterable

public <T> @Nullable Iterable<T> getIterable(int idx)

Get an iterable value by field index, IllegalStateException is thrown if schema doesn't match.

getMap

public <T1,
T2> @Nullable Map<T1,T2> getMap(int idx)

Get a MAP value by field index, IllegalStateException is thrown if schema doesn't match.

getLogicalTypeValue

public <T extends @Nullable Object> T getLogicalTypeValue(int idx,
 Class<T> clazz)

Returns the Logical Type input type for this field. IllegalStateException is thrown if schema doesn't match.

getBaseValue

public <T extends @Nullable Object> T getBaseValue(int idx,
 Class<T> clazz)

Returns the base type for this field. If this is a logical type, we convert to the base value. Otherwise the field itself is returned.

getBaseValue

public @Nullable Object getBaseValue(int idx)

Returns the base type for this field. If this is a logical type, we convert to the base value. Otherwise the field itself is returned.

getRow

public @Nullable Row getRow(int idx)

Get a Row value by field index, IllegalStateException is thrown if schema doesn't match.

getSchema

public Schema getSchema()

Return Schema which describes the fields.

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toString

public String toString(boolean includeFieldNames)

Convert Row to String.

withSchema

public static Row.Builder withSchema(Schema schema)

Creates a row builder with specified getSchema(). Row.Builder.build() will throw an IllegalArgumentException if number of fields in getSchema() does not match the number of fields specified. If any of the arguments don't match the expected types for the schema fields, Row.Builder.build() will throw a ClassCastException.

fromRow

public static Row.FieldValueBuilder fromRow(Row row)

Creates a row builder based on the specified row. Field values in the new row can be explicitly set using Row.FieldValueBuilder.withFieldValue(java.lang.String, java.lang.Object). Any values not so overridden will be the same as the values in the original row.

toRow

public static <T> Collector<T,List<Object>,Row> toRow(Schema schema)

Creates a Row from the list of values and getSchema().

nullRow

public static Row nullRow(Schema schema)

Creates a new record filled with nulls.

sorted

public Row sorted()

Returns an equivalent Row with fields lexicographically sorted by their name.

toSnakeCase

public Row toSnakeCase()

Returns an equivalent Row with `snake_case` field names.

toCamelCase

public Row toCamelCase()

Returns an equivalent Row with `lowerCamelCase` field names.