Class ExtractJobConfiguration.Builder (2.44.0) 

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

Inheritance

java.lang.Object > JobConfiguration.Builder > ExtractJobConfiguration.Builder

Methods

build()

public ExtractJobConfiguration build()

Creates an object.

Returns
Type Description
ExtractJobConfiguration
Overrides

setCompression(String compression)

public ExtractJobConfiguration.Builder setCompression(String compression)

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

Compression

Parameter
Name Description
compression String
Returns
Type Description
ExtractJobConfiguration.Builder

setDestinationUris(List<String> destinationUris)

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.

Parameter
Name Description
destinationUris List<String>
Returns
Type Description
ExtractJobConfiguration.Builder

setFieldDelimiter(String fieldDelimiter)

public ExtractJobConfiguration.Builder setFieldDelimiter(String fieldDelimiter)

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

Parameter
Name Description
fieldDelimiter String
Returns
Type Description
ExtractJobConfiguration.Builder

setFormat(String format)

public ExtractJobConfiguration.Builder setFormat(String format)

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

Destination Format

Parameter
Name Description
format String
Returns
Type Description
ExtractJobConfiguration.Builder

setJobTimeoutMs(Long jobTimeoutMs)

public ExtractJobConfiguration.Builder setJobTimeoutMs(Long jobTimeoutMs)

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

Parameter
Name Description
jobTimeoutMs Long

jobTimeoutMs or null for none
Returns
Type Description
ExtractJobConfiguration.Builder

setLabels(Map<String,String> labels)

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.

Parameter
Name Description
labels Map<String,String>

labels or null for none
Returns
Type Description
ExtractJobConfiguration.Builder

setPrintHeader(Boolean printHeader)

public ExtractJobConfiguration.Builder setPrintHeader(Boolean printHeader)

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

Parameter
Name Description
printHeader Boolean
Returns
Type Description
ExtractJobConfiguration.Builder

setSourceModel(ModelId sourceModel)

public ExtractJobConfiguration.Builder setSourceModel(ModelId sourceModel)

Sets the model to export.

Parameter
Name Description
sourceModel ModelId
Returns
Type Description
ExtractJobConfiguration.Builder

setSourceTable(TableId sourceTable)

public ExtractJobConfiguration.Builder setSourceTable(TableId sourceTable)

Sets the table to export.

Parameter
Name Description
sourceTable TableId
Returns
Type Description
ExtractJobConfiguration.Builder

setUseAvroLogicalTypes(Boolean useAvroLogicalTypes)

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).

Parameter
Name Description
useAvroLogicalTypes Boolean

useAvroLogicalTypes or null for none
Returns
Type Description
ExtractJobConfiguration.Builder