Class Field (2.42.3) 

public final class Field implements Serializable

Google BigQuery Table schema field. A table field has a name, a type, a mode and possibly a description.

Inheritance

Object > Field

Implements

Serializable

Static Methods

newBuilder(String name, LegacySQLTypeName type, Field[] subFields)

public static Field.Builder newBuilder(String name, LegacySQLTypeName type, Field[] subFields)

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

Parameters
Name Description
name String
type LegacySQLTypeName
subFields Field[]
Returns
Type Description
Field.Builder

newBuilder(String name, LegacySQLTypeName type, FieldList subFields)

public static Field.Builder newBuilder(String name, LegacySQLTypeName type, FieldList subFields)

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

Parameters
Name Description
name String
type LegacySQLTypeName
subFields FieldList
Returns
Type Description
Field.Builder

newBuilder(String name, StandardSQLTypeName type, Field[] subFields)

public static Field.Builder newBuilder(String name, StandardSQLTypeName type, Field[] subFields)

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

Parameters
Name Description
name String
type StandardSQLTypeName
subFields Field[]
Returns
Type Description
Field.Builder

newBuilder(String name, StandardSQLTypeName type, FieldList subFields)

public static Field.Builder newBuilder(String name, StandardSQLTypeName type, FieldList subFields)

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

Parameters
Name Description
name String
type StandardSQLTypeName
subFields FieldList
Returns
Type Description
Field.Builder

of(String name, LegacySQLTypeName type, Field[] subFields)

public static Field of(String name, LegacySQLTypeName type, Field[] subFields)

Returns a Field object with given name and type.

Parameters
Name Description
name String
type LegacySQLTypeName
subFields Field[]
Returns
Type Description
Field

of(String name, LegacySQLTypeName type, FieldList subFields)

public static Field of(String name, LegacySQLTypeName type, FieldList subFields)

Returns a Field object with given name and type.

Parameters
Name Description
name String
type LegacySQLTypeName
subFields FieldList
Returns
Type Description
Field

of(String name, StandardSQLTypeName type, Field[] subFields)

public static Field of(String name, StandardSQLTypeName type, Field[] subFields)

Returns a Field object with given name and type.

Parameters
Name Description
name String
type StandardSQLTypeName
subFields Field[]
Returns
Type Description
Field

of(String name, StandardSQLTypeName type, FieldList subFields)

public static Field of(String name, StandardSQLTypeName type, FieldList subFields)

Returns a Field object with given name and type.

Parameters
Name Description
name String
type StandardSQLTypeName
subFields FieldList
Returns
Type Description
Field

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCollation()

public String getCollation()
Returns
Type Description
String

getDefaultValueExpression()

public String getDefaultValueExpression()

Return the default value of the field.

Returns
Type Description
String

getDescription()

public String getDescription()

Returns the field description.

Returns
Type Description
String

getMaxLength()

public Long getMaxLength()

Returns the maximum length of the field for STRING or BYTES type.

Returns
Type Description
Long

getMode()

public Field.Mode getMode()

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

Returns
Type Description
Field.Mode

getName()

public String getName()

Returns the field name.

Returns
Type Description
String

getPolicyTags()

public PolicyTags getPolicyTags()

Returns the policy tags for the field.

Returns
Type Description
PolicyTags

getPrecision()

public Long getPrecision()

Returns the maximum number of total digits allowed for NUMERIC or BIGNUMERIC types.

Returns
Type Description
Long

getRangeElementType()

public FieldElementType getRangeElementType()

Return the range element type the field.

Returns
Type Description
FieldElementType

getScale()

public Long getScale()

Returns the maximum number of digits set in the fractional part of a NUMERIC or BIGNUMERIC type.

Returns
Type Description
Long

getSubFields()

public FieldList getSubFields()

Returns the list of sub-fields if #getType() is a LegacySQLTypeName#RECORD. Returns null otherwise.

Returns
Type Description
FieldList

getType()

public LegacySQLTypeName getType()

Returns the field type. See Also: Data Types

Returns
Type Description
LegacySQLTypeName

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

toBuilder()

public Field.Builder toBuilder()

Returns a builder for the Field object.

Returns
Type Description
Field.Builder

toString()

public String toString()
Returns
Type Description
String
Overrides