com.google.cloud.bigquery

Class Field

java.lang.Object

com.google.cloud.bigquery.Field

All Implemented Interfaces:

Serializable

public final class Field
extends Object
implements Serializable

Google BigQuery Table field. A table field has a name, a type, a mode and possibly a description. Supported types are: Field.Type.integer(), Field.Type.bool(), Field.Type.string(), Field.Type.floatingPoint(), Field.Type.timestamp() and Field.Type.record(Field...). One or more fields form a table's schema.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Field.Builder
static class	Field.Mode Mode for a BigQuery Table field.
static class	Field.Type Data Types for a BigQuery Table field.

Method Summary

Methods

Modifier and Type	Method and Description
static Field.Builder	builder(String name, Field.Type type) Returns a builder for a Field object with given name and value.
String	description() Returns the field description.
boolean	equals(Object obj)
List<Field>	fields() Returns the list of sub-fields if type() is a Field.Type.Value.RECORD.
int	hashCode()
Field.Mode	mode() Returns the field mode.
String	name() Returns the field name.
static Field	of(String name, Field.Type type) Returns a Field object with given name and value.
Field.Builder	toBuilder() Returns a builder for the Field object.
String	toString()
Field.Type	type() Returns the field value.

Methods inherited from class java.lang.Object

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

Method Detail

name

public String name()

Returns the field name.

type

public Field.Type type()

Returns the field value.

See Also:

Data Types

mode

public Field.Mode mode()

Returns the field mode. By default Field.Mode.NULLABLE is used.

description

public String description()

Returns the field description.

fields

public List<Field> fields()

Returns the list of sub-fields if type() is a Field.Type.Value.RECORD. Returns null otherwise.

toBuilder

public Field.Builder toBuilder()

Returns a builder for the Field object.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

of

public static Field of(String name,
       Field.Type type)

Returns a Field object with given name and value.

builder

public static Field.Builder builder(String name,
                    Field.Type type)

Returns a builder for a Field object with given name and value.