BeamRecord

java.lang.Object
- org.apache.beam.sdk.values.BeamRecord

All Implemented Interfaces:

java.io.Serializable
```
@Experimental
public class BeamRecord
extends java.lang.Object
implements java.io.Serializable
```
BeamRecord is an immutable tuple-like type to represent one element in a PCollection. The fields are described with a BeamRecordType.
By default, BeamRecordType only contains the name for each field. It can be extended to support more sophisticated validation by overwriting BeamRecordType.validateValueType(int, Object).
A Coder BeamRecordCoder is provided, which wraps the Coder for each data field.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`BeamRecord(BeamRecordType dataType, java.util.List<java.lang.Object> rawDataValues)` Creates a BeamRecord.
`BeamRecord(BeamRecordType dataType, java.lang.Object... rawdataValues)` see `BeamRecord(BeamRecordType, List)`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.math.BigDecimal`	`getBigDecimal(int idx)` Get a `BigDecimal` value by field index, `ClassCastException` is thrown if type doesn't match.
`java.math.BigDecimal`	`getBigDecimal(java.lang.String fieldName)` Get a `BigDecimal` value by field name, `ClassCastException` is thrown if type doesn't match.
`java.lang.Boolean`	`getBoolean(int idx)` Get a `Boolean` value by field index, `ClassCastException` is thrown if type doesn't match.
`java.lang.Boolean`	`getBoolean(java.lang.String fieldName)` Get a `Boolean` value by field name, `ClassCastException` is thrown if type doesn't match.
`java.lang.Byte`	`getByte(int idx)` Get a `Byte` value by field index, `ClassCastException` is thrown if type doesn't match.
`java.lang.Byte`	`getByte(java.lang.String fieldName)` Get a `Byte` value by field name, `ClassCastException` is thrown if type doesn't match.
`BeamRecordType`	`getDataType()` Return `BeamRecordType` which describes the fields.
`java.util.List<java.lang.Object>`	`getDataValues()` Return the list of data values.
`java.util.Date`	`getDate(int idx)` Get a `Date` value by field index, `ClassCastException` is thrown if type doesn't match.
`java.util.Date`	`getDate(java.lang.String fieldName)` Get a `Date` value by field name, `ClassCastException` is thrown if type doesn't match.
`java.lang.Double`	`getDouble(int idx)` Get a `Double` value by field index, `ClassCastException` is thrown if type doesn't match.
`java.lang.Double`	`getDouble(java.lang.String fieldName)` Get a `Double` value by field name, `ClassCastException` is thrown if type doesn't match.
`int`	`getFieldCount()` Return the size of data fields.
`java.lang.Object`	`getFieldValue(int fieldIdx)` Get value by field index.
`java.lang.Object`	`getFieldValue(java.lang.String fieldName)` Get value by field name.
`java.lang.Float`	`getFloat(int idx)` Get a `Float` value by field index, `ClassCastException` is thrown if type doesn't match.
`java.lang.Float`	`getFloat(java.lang.String fieldName)` Get a `Float` value by field name, `ClassCastException` is thrown if type doesn't match.
`java.util.GregorianCalendar`	`getGregorianCalendar(int idx)` Get a `GregorianCalendar` value by field index, `ClassCastException` is thrown if type doesn't match.
`java.util.GregorianCalendar`	`getGregorianCalendar(java.lang.String fieldName)` Get a `GregorianCalendar` value by field name, `ClassCastException` is thrown if type doesn't match.
`java.lang.Integer`	`getInteger(int idx)` Get a `Integer` value by field index, `ClassCastException` is thrown if type doesn't match.
`java.lang.Integer`	`getInteger(java.lang.String fieldName)` Get a `Integer` value by field name, `ClassCastException` is thrown if type doesn't match.
`java.lang.Long`	`getLong(int idx)` Get a `Long` value by field index, `ClassCastException` is thrown if type doesn't match.
`java.lang.Long`	`getLong(java.lang.String fieldName)` Get a `Long` value by field name, `ClassCastException` is thrown if type doesn't match.
`java.lang.Short`	`getShort(int idx)` Get a `Short` value by field index, `ClassCastException` is thrown if type doesn't match.
`java.lang.Short`	`getShort(java.lang.String fieldName)` Get a `Short` value by field name, `ClassCastException` is thrown if type doesn't match.
`java.lang.String`	`getString(int idx)` Get a `String` value by field index, `ClassCastException` is thrown if type doesn't match.
`java.lang.String`	`getString(java.lang.String fieldName)` Get a `String` value by field name, `ClassCastException` is thrown if type doesn't match.
`int`	`hashCode()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BeamRecord
```
public BeamRecord(BeamRecordType dataType,
                  java.util.List<java.lang.Object> rawDataValues)
```
    Creates a BeamRecord.
    
    Parameters:
    
    dataType - type of the record
    
    rawDataValues - values of the record, record's size must match size of the BeamRecordType, or can be null, if it is null then every field is null.
  - BeamRecord
```
public BeamRecord(BeamRecordType dataType,
                  java.lang.Object... rawdataValues)
```
    see BeamRecord(BeamRecordType, List).
- Method Detail
  - getFieldValue
```
public java.lang.Object getFieldValue(java.lang.String fieldName)
```
    Get value by field name.
  - getByte
```
public java.lang.Byte getByte(java.lang.String fieldName)
```
    Get a Byte value by field name, ClassCastException is thrown if type doesn't match.
  - getShort
```
public java.lang.Short getShort(java.lang.String fieldName)
```
    Get a Short value by field name, ClassCastException is thrown if type doesn't match.
  - getInteger
```
public java.lang.Integer getInteger(java.lang.String fieldName)
```
    Get a Integer value by field name, ClassCastException is thrown if type doesn't match.
  - getFloat
```
public java.lang.Float getFloat(java.lang.String fieldName)
```
    Get a Float value by field name, ClassCastException is thrown if type doesn't match.
  - getDouble
```
public java.lang.Double getDouble(java.lang.String fieldName)
```
    Get a Double value by field name, ClassCastException is thrown if type doesn't match.
  - getLong
```
public java.lang.Long getLong(java.lang.String fieldName)
```
    Get a Long value by field name, ClassCastException is thrown if type doesn't match.
  - getString
```
public java.lang.String getString(java.lang.String fieldName)
```
    Get a String value by field name, ClassCastException is thrown if type doesn't match.
  - getDate
```
public java.util.Date getDate(java.lang.String fieldName)
```
    Get a Date value by field name, ClassCastException is thrown if type doesn't match.
  - getGregorianCalendar
```
public java.util.GregorianCalendar getGregorianCalendar(java.lang.String fieldName)
```
    Get a GregorianCalendar value by field name, ClassCastException is thrown if type doesn't match.
  - getBigDecimal
```
public java.math.BigDecimal getBigDecimal(java.lang.String fieldName)
```
    Get a BigDecimal value by field name, ClassCastException is thrown if type doesn't match.
  - getBoolean
```
public java.lang.Boolean getBoolean(java.lang.String fieldName)
```
    Get a Boolean value by field name, ClassCastException is thrown if type doesn't match.
  - getFieldValue
```
@Nullable
public java.lang.Object getFieldValue(int fieldIdx)
```
    Get value by field index.
  - getByte
```
public java.lang.Byte getByte(int idx)
```
    Get a Byte value by field index, ClassCastException is thrown if type doesn't match.
  - getShort
```
public java.lang.Short getShort(int idx)
```
    Get a Short value by field index, ClassCastException is thrown if type doesn't match.
  - getInteger
```
public java.lang.Integer getInteger(int idx)
```
    Get a Integer value by field index, ClassCastException is thrown if type doesn't match.
  - getFloat
```
public java.lang.Float getFloat(int idx)
```
    Get a Float value by field index, ClassCastException is thrown if type doesn't match.
  - getDouble
```
public java.lang.Double getDouble(int idx)
```
    Get a Double value by field index, ClassCastException is thrown if type doesn't match.
  - getLong
```
public java.lang.Long getLong(int idx)
```
    Get a Long value by field index, ClassCastException is thrown if type doesn't match.
  - getString
```
public java.lang.String getString(int idx)
```
    Get a String value by field index, ClassCastException is thrown if type doesn't match.
  - getDate
```
public java.util.Date getDate(int idx)
```
    Get a Date value by field index, ClassCastException is thrown if type doesn't match.
  - getGregorianCalendar
```
public java.util.GregorianCalendar getGregorianCalendar(int idx)
```
    Get a GregorianCalendar value by field index, ClassCastException is thrown if type doesn't match.
  - getBigDecimal
```
public java.math.BigDecimal getBigDecimal(int idx)
```
    Get a BigDecimal value by field index, ClassCastException is thrown if type doesn't match.
  - getBoolean
```
public java.lang.Boolean getBoolean(int idx)
```
    Get a Boolean value by field index, ClassCastException is thrown if type doesn't match.
  - getFieldCount
```
public int getFieldCount()
```
    Return the size of data fields.
  - getDataValues
```
public java.util.List<java.lang.Object> getDataValues()
```
    Return the list of data values.
  - getDataType
```
public BeamRecordType getDataType()
```
    Return BeamRecordType which describes the fields.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class BeamRecord

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BeamRecord

BeamRecord

Method Detail

getFieldValue

getByte

getShort

getInteger

getFloat

getDouble

getLong

getString

getDate

getGregorianCalendar

getBigDecimal

getBoolean

getFieldValue

getByte

getShort

getInteger

getFloat

getDouble

getLong

getString

getDate

getGregorianCalendar

getBigDecimal

getBoolean

getFieldCount

getDataValues

getDataType

toString

equals

hashCode