Class FormatOptions (2.41.0)

public class FormatOptions implements Serializable

Base class for Google BigQuery format options. These class define the format of external data used by BigQuery, for either federated tables or load jobs.

Load jobs support the following formats: AVRO, CSV, DATASTORE_BACKUP, GOOGLE_SHEETS, JSON, ORC, PARQUET

Federated tables can be defined against following formats: AVRO, BIGTABLE, CSV, DATASTORE_BACKUP, GOOGLE_SHEETS, JSON

Inheritance

Object > FormatOptions

Implements

Serializable

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

avro()

public static AvroOptions avro()

Default options for AVRO format.

Returns
Type	Description
`AvroOptions`

bigtable()

public static FormatOptions bigtable()

Default options for BIGTABLE format.

Returns
Type	Description
`FormatOptions`

csv()

public static CsvOptions csv()

Default options for CSV format.

Returns
Type	Description
`CsvOptions`

datastoreBackup()

public static FormatOptions datastoreBackup()

Default options for DATASTORE_BACKUP format.

Returns
Type	Description
`FormatOptions`

googleSheets()

public static FormatOptions googleSheets()

Default options for GOOGLE_SHEETS format.

Returns
Type	Description
`FormatOptions`

iceberg()

public static FormatOptions iceberg()

Default options for the Apache Iceberg table format.

Returns
Type	Description
`FormatOptions`

json()

public static FormatOptions json()

Default options for NEWLINE_DELIMITED_JSON format.

Returns
Type	Description
`FormatOptions`

of(String format)

public static FormatOptions of(String format)

Default options for the provided format.

Parameter
Name	Description
`format`	`String`

Returns
Type	Description
`FormatOptions`

orc()

public static FormatOptions orc()

Default options for the ORC format.

Returns
Type	Description
`FormatOptions`

parquet()

public static FormatOptions parquet()

Default options for PARQUET format.

Returns
Type	Description
`FormatOptions`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

Object.equals(Object)

getType()

public String getType()

Returns the external data format, as a string.

Returns
Type	Description
`String`

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

Object.hashCode()

toString()

public String toString()

Returns
Type	Description
`String`

Overrides

Object.toString()