com.google.cloud.bigquery

Class ExtractJobConfiguration.Builder

java.lang.Object

com.google.cloud.bigquery.JobConfiguration.Builder<ExtractJobConfiguration,ExtractJobConfiguration.Builder>

com.google.cloud.bigquery.ExtractJobConfiguration.Builder

Enclosing class:

ExtractJobConfiguration

public static final class ExtractJobConfiguration.Builder
extends JobConfiguration.Builder<ExtractJobConfiguration,ExtractJobConfiguration.Builder>

Method Summary

Modifier and Type	Method and Description
ExtractJobConfiguration	build() Creates an object.
ExtractJobConfiguration.Builder	setCompression(String compression) Sets the compression value to use for exported files.
ExtractJobConfiguration.Builder	setDestinationUris(List<String> destinationUris) Sets the list of fully-qualified Google Cloud Storage URIs (e.g.
ExtractJobConfiguration.Builder	setFieldDelimiter(String fieldDelimiter) Sets the delimiter to use between fields in the exported data.
ExtractJobConfiguration.Builder	setFormat(String format) Sets the exported file format.
ExtractJobConfiguration.Builder	setJobTimeoutMs(Long jobTimeoutMs) [Optional] Job timeout in milliseconds.
ExtractJobConfiguration.Builder	setLabels(Map<String,String> labels) The labels associated with this job.
ExtractJobConfiguration.Builder	setPrintHeader(Boolean printHeader) Sets whether to print out a header row in the results.
ExtractJobConfiguration.Builder	setSourceTable(TableId sourceTable) Sets the table to export.
ExtractJobConfiguration.Builder	setUseAvroLogicalTypes(Boolean useAvroLogicalTypes) [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long).

Methods inherited from class java.lang.Object

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

Method Detail

setSourceTable

public ExtractJobConfiguration.Builder setSourceTable(TableId sourceTable)

Sets the table to export.

setDestinationUris

public ExtractJobConfiguration.Builder setDestinationUris(List<String> destinationUris)

Sets the list of fully-qualified Google Cloud Storage URIs (e.g. gs://bucket/path) where the extracted table should be written.

setPrintHeader

public ExtractJobConfiguration.Builder setPrintHeader(Boolean printHeader)

Sets whether to print out a header row in the results. By default an header is printed.

setFieldDelimiter

public ExtractJobConfiguration.Builder setFieldDelimiter(String fieldDelimiter)

Sets the delimiter to use between fields in the exported data. By default "," is used.

setFormat

public ExtractJobConfiguration.Builder setFormat(String format)

Sets the exported file format. If not set table is exported in CSV format.

Destination Format

setCompression

public ExtractJobConfiguration.Builder setCompression(String compression)

Sets the compression value to use for exported files. If not set exported files are not compressed.

Compression

setUseAvroLogicalTypes

public ExtractJobConfiguration.Builder setUseAvroLogicalTypes(Boolean useAvroLogicalTypes)

[Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long).

Parameters:

useAvroLogicalTypes - useAvroLogicalTypes or null for none

setLabels

public ExtractJobConfiguration.Builder setLabels(Map<String,String> labels)

The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.

Parameters:

labels - labels or null for none

setJobTimeoutMs

public ExtractJobConfiguration.Builder setJobTimeoutMs(Long jobTimeoutMs)

[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.

Parameters:

jobTimeoutMs - jobTimeoutMs or null for none

build

public ExtractJobConfiguration build()

Description copied from class: JobConfiguration.Builder

Creates an object.

Specified by:

build in class JobConfiguration.Builder<ExtractJobConfiguration,ExtractJobConfiguration.Builder>