org.apache.beam.sdk.io.gcp.bigquery

Enum BigQueryIO.Write.SchemaUpdateOption

java.lang.Object

java.lang.Enum<BigQueryIO.Write.SchemaUpdateOption>

org.apache.beam.sdk.io.gcp.bigquery.BigQueryIO.Write.SchemaUpdateOption

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BigQueryIO.Write.SchemaUpdateOption>

Enclosing class:

BigQueryIO.Write<T>

public static enum BigQueryIO.Write.SchemaUpdateOption
extends java.lang.Enum<BigQueryIO.Write.SchemaUpdateOption>

An enumeration type for the BigQuery schema update options strings.

Not supported for Method#STREAMING_INSERTS.

Note from the BigQuery API doc -- Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. When updating a pipeline with a new schema, the existing schmea fields must stay in the same order, or the pipeline will break.

See Also:

configuration.query.schemaUpdateOptions in the BigQuery Jobs API

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALLOW_FIELD_ADDITION Allow adding a nullable field to the schema.
ALLOW_FIELD_RELAXATION Allow relaxing a required field in the original schema to nullable.

Method Summary

Modifier and Type	Method and Description
static BigQueryIO.Write.SchemaUpdateOption	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BigQueryIO.Write.SchemaUpdateOption[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALLOW_FIELD_ADDITION

public static final BigQueryIO.Write.SchemaUpdateOption ALLOW_FIELD_ADDITION

Allow adding a nullable field to the schema.

ALLOW_FIELD_RELAXATION

public static final BigQueryIO.Write.SchemaUpdateOption ALLOW_FIELD_RELAXATION

Allow relaxing a required field in the original schema to nullable.

Method Detail

values

public static BigQueryIO.Write.SchemaUpdateOption[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BigQueryIO.Write.SchemaUpdateOption c : BigQueryIO.Write.SchemaUpdateOption.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BigQueryIO.Write.SchemaUpdateOption valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null