Package com.google.cloud.bigquery

Class FieldValue

java.lang.Object

com.google.cloud.bigquery.FieldValue

All Implemented Interfaces:

Serializable

public class FieldValue
extends Object
implements Serializable

Google BigQuery Table Field Value class. Objects of this class represent values of a BigQuery Table Field. A list of values forms a table row. Tables rows can be gotten as the result of a query or when listing table data.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FieldValue.Attribute	The field value's attribute, giving information on the field's content type.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object obj)
FieldValue.Attribute	getAttribute()	Returns the attribute of this Field Value.
boolean	getBooleanValue()	Returns this field's value as a Boolean.
byte[]	getBytesValue()	Returns this field's value as a byte array.
double	getDoubleValue()	Returns this field's value as a Double.
long	getLongValue()	Returns this field's value as a long.
BigDecimal	getNumericValue()	Returns this field's value as a BigDecimal.
org.threeten.extra.PeriodDuration	getPeriodDuration()	Returns this field's value as a PeriodDuration.
Range	getRangeValue()	Returns this field's value as a Range.
FieldValueList	getRecordValue()	Returns this field's value as a FieldValueList instance.
List<FieldValue>	getRepeatedValue()	Returns this field's value as a list of FieldValue.
String	getStringValue()	Returns this field's value as a String.
String	getStringValueOrDefault(String defaultValue)	Returns this field's value as a String, or defaultValue if isNull() returns true.
Instant	getTimestampInstant()	Returns this field's value as a String, representing a timestamp as an Instant.
long	getTimestampValue()	Returns this field's value as a long, representing a timestamp in microseconds since epoch (UNIX time).
Boolean	getUseInt64Timestamps()
Object	getValue()	Returns this field's value as an Object.
final int	hashCode()
boolean	isNull()	Returns true if this field's value is null, false otherwise.
static FieldValue	of(FieldValue.Attribute attribute, Object value)	Creates an instance of FieldValue, useful for testing.
static FieldValue	of(FieldValue.Attribute attribute, Object value, Boolean useInt64Timestamps)
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getAttribute

public FieldValue.Attribute getAttribute()

Returns the attribute of this Field Value.

Returns:

FieldValue.Attribute.PRIMITIVE if the field is a primitive type (LegacySQLTypeName.BYTES, LegacySQLTypeName.BOOLEAN, LegacySQLTypeName.STRING, LegacySQLTypeName.FLOAT, LegacySQLTypeName.INTEGER, LegacySQLTypeName.NUMERIC, LegacySQLTypeName.TIMESTAMP, LegacySQLTypeName.GEOGRAPHY) or is null.

Returns FieldValue.Attribute.REPEATED if the corresponding field has (Field.Mode.REPEATED) mode. Returns FieldValue.Attribute.RECORD if the corresponding field is a LegacySQLTypeName.RECORD type.

isNull

public boolean isNull()

Returns true if this field's value is null, false otherwise.

getValue

public Object getValue()

Returns this field's value as an Object. If isNull() is true this method returns null.

getUseInt64Timestamps

public Boolean getUseInt64Timestamps()

getStringValue

public String getStringValue()

Returns this field's value as a String. This method should only be used if the corresponding field has primitive type (LegacySQLTypeName.BYTES, LegacySQLTypeName.BOOLEAN, LegacySQLTypeName.STRING, LegacySQLTypeName.FLOAT, LegacySQLTypeName.INTEGER, LegacySQLTypeName.NUMERIC LegacySQLTypeName.TIMESTAMP).

Throws:

ClassCastException - if the field is not a primitive type

NullPointerException - if isNull() returns true

getStringValueOrDefault

public String getStringValueOrDefault(String defaultValue)

Returns this field's value as a String, or defaultValue if isNull() returns true. See getStringValue() for more details.

Throws:

ClassCastException - if the field is not a primitive type

getBytesValue

public byte[] getBytesValue()

Returns this field's value as a byte array. This method should only be used if the corresponding field has primitive type (LegacySQLTypeName.BYTES.

Throws:

ClassCastException - if the field is not a primitive type

NullPointerException - if isNull() returns true

IllegalStateException - if the field value is not encoded in base64

getLongValue

public long getLongValue()

Returns this field's value as a long. This method should only be used if the corresponding field has LegacySQLTypeName.INTEGER type.

Throws:

ClassCastException - if the field is not a primitive type

NumberFormatException - if the field's value could not be converted to Integer

NullPointerException - if isNull() returns true

getDoubleValue

public double getDoubleValue()

Returns this field's value as a Double. This method should only be used if the corresponding field has LegacySQLTypeName.FLOAT type.

Throws:

ClassCastException - if the field is not a primitive type

NumberFormatException - if the field's value could not be converted to Double

NullPointerException - if isNull() returns true

getBooleanValue

public boolean getBooleanValue()

Returns this field's value as a Boolean. This method should only be used if the corresponding field has LegacySQLTypeName.BOOLEAN type.

Throws:

ClassCastException - if the field is not a primitive type

IllegalStateException - if the field's value could not be converted to Boolean

NullPointerException - if isNull() returns true

getTimestampValue

public long getTimestampValue()

Returns this field's value as a long, representing a timestamp in microseconds since epoch (UNIX time). This method should only be used if the corresponding field has LegacySQLTypeName.TIMESTAMP type.

Throws:

ClassCastException - if the field is not a primitive type

NumberFormatException - if the field's value could not be converted to Long

NullPointerException - if isNull() returns true

getTimestampInstant

public Instant getTimestampInstant()

Returns this field's value as a String, representing a timestamp as an Instant. This method should only be used if the corresponding field has LegacySQLTypeName.TIMESTAMP type.

Throws:

ClassCastException - if the field is not a primitive type

NumberFormatException - if the field's value could not be converted to Long

NullPointerException - if isNull() returns true

getNumericValue

public BigDecimal getNumericValue()

Returns this field's value as a BigDecimal. This method should only be used if the corresponding field has LegacySQLTypeName.NUMERIC type.

Throws:

ClassCastException - if the field is not a primitive type

NumberFormatException - if the field's value could not be converted to BigDecimal

NullPointerException - if isNull() returns true

getRangeValue

public Range getRangeValue()

Returns this field's value as a Range. This method should only be used * if the corresponding field has LegacySQLTypeName.RANGE type.

Throws:

ClassCastException - if the field is not a primitive type

IllegalArgumentException - if the field's value could not be converted to Range

NullPointerException - if isNull() returns true

getRepeatedValue

public List<FieldValue> getRepeatedValue()

Returns this field's value as a list of FieldValue. This method should only be used if the corresponding field has Field.Mode.REPEATED mode (i.e. getAttribute() is FieldValue.Attribute.REPEATED).

Throws:

ClassCastException - if the field has not Field.Mode.REPEATED mode

NullPointerException - if isNull() returns true

getPeriodDuration

public org.threeten.extra.PeriodDuration getPeriodDuration()

Returns this field's value as a PeriodDuration. This method should be used if the corresponding field has StandardSQLTypeName.INTERVAL type, or if it is a legal canonical format "[sign]Y-M [sign]D [sign]H:M:S[.F]", e.g. "123-7 -19 0:24:12.000006" or ISO 8601.

Throws:

ClassCastException - if the field is not a primitive type

NullPointerException - if isNull() returns true

IllegalArgumentException - if the field cannot be converted to a legal interval

getRecordValue

public FieldValueList getRecordValue()

Returns this field's value as a FieldValueList instance. This method should only be used if the corresponding field has LegacySQLTypeName.RECORD type (i.e. getAttribute() is FieldValue.Attribute.RECORD).

Throws:

ClassCastException - if the field is not a LegacySQLTypeName.RECORD type

NullPointerException - if isNull() returns true

toString

public String toString()

Overrides:

toString in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

of

@BetaApi
public static FieldValue of(FieldValue.Attribute attribute,
 Object value)

Creates an instance of FieldValue, useful for testing.

If the attribute is FieldValue.Attribute.PRIMITIVE, the value should be the string representation of the underlying value, eg "123" for number 123.

If the attribute is FieldValue.Attribute.REPEATED or FieldValue.Attribute.RECORD, the value should be List of FieldValues or FieldValueList, respectively.

This method is unstable. See this discussion for more context.

of

@BetaApi
public static FieldValue of(FieldValue.Attribute attribute,
 Object value,
 Boolean useInt64Timestamps)