com.google.cloud.bigquery

Class Field.Builder

java.lang.Object

com.google.cloud.bigquery.Field.Builder

Enclosing class:

Field

public static final class Field.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
Field	build() Creates a Field object.
Field.Builder	setDescription(String description) Sets the field description.
Field.Builder	setMode(Field.Mode mode) Sets the mode of the field.
Field.Builder	setName(String name) Sets the field name.
Field.Builder	setType(LegacySQLTypeName type, Field... subFields) Sets the type of the field.
Field.Builder	setType(LegacySQLTypeName type, FieldList subFields) Sets the type of the field.
Field.Builder	setType(StandardSQLTypeName type, Field... subFields) Sets the type of the field.
Field.Builder	setType(StandardSQLTypeName type, FieldList subFields) Sets the type of the field.

Methods inherited from class java.lang.Object

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

Method Detail

setName

public Field.Builder setName(String name)

Sets the field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.

setType

public Field.Builder setType(LegacySQLTypeName type,
                             Field... subFields)

Sets the type of the field.

Parameters:

type - BigQuery data type

subFields - nested schema fields in case if type is LegacySQLTypeName.RECORD, empty otherwise

Throws:

IllegalArgumentException - if type == LegacySQLTypeName.RECORD && subFields.length == 0 or if type != LegacySQLTypeName.RECORD && subFields.length != 0

See Also:

Data Types

setType

public Field.Builder setType(StandardSQLTypeName type,
                             Field... subFields)

Sets the type of the field.

Parameters:

type - BigQuery data type

subFields - nested schema fields in case if type is StandardSQLTypeName.STRUCT, empty otherwise

Throws:

IllegalArgumentException - if type == StandardSQLTypeName.STRUCT && subFields.length == 0 or if type != StandardSQLTypeName.STRUCT && subFields.length != 0

See Also:

Data Types

setType

public Field.Builder setType(LegacySQLTypeName type,
                             FieldList subFields)

Sets the type of the field.

Parameters:

type - BigQuery data type

subFields - nested schema fields, in case if type is LegacySQLTypeName.RECORD, null otherwise.

Throws:

IllegalArgumentException - if type == LegacySQLTypeName.RECORD && (subFields == null || subFields.isEmpty()) or if type != LegacySQLTypeName.RECORD && subFields != null

See Also:

Data Types

setType

public Field.Builder setType(StandardSQLTypeName type,
                             FieldList subFields)

Sets the type of the field.

Parameters:

type - BigQuery data type

subFields - nested schema fields in case if type is StandardSQLTypeName.STRUCT, empty otherwise

Throws:

IllegalArgumentException - if type == StandardSQLTypeName.STRUCT && subFields.length == 0 or if type != StandardSQLTypeName.STRUCT && subFields.length != 0

See Also:

Data Types

setMode

public Field.Builder setMode(Field.Mode mode)

Sets the mode of the field. When not specified Field.Mode.NULLABLE is used.

setDescription

public Field.Builder setDescription(String description)

Sets the field description. The maximum length is 16K characters.

build

public Field build()

Creates a Field object.