Package 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 TypeMethodDescriptionbuild()
Creates an object.setCompression
(String compression) Sets the compression value to use for exported files.setDestinationUris
(List<String> destinationUris) Sets the list of fully-qualified Google Cloud Storage URIs (e.g.setFieldDelimiter
(String fieldDelimiter) Sets the delimiter to use between fields in the exported data.Sets the exported file format.setJobTimeoutMs
(Long jobTimeoutMs) [Optional] Job timeout in milliseconds.The labels associated with this job.setPrintHeader
(Boolean printHeader) Sets whether to print out a header row in the results.setSourceModel
(ModelId sourceModel) Sets the model to export.setSourceTable
(TableId sourceTable) Sets the table to export.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).
-
Method Details
-
setSourceTable
Sets the table to export. -
setSourceModel
Sets the model to export. -
setDestinationUris
Sets the list of fully-qualified Google Cloud Storage URIs (e.g. gs://bucket/path) where the extracted table should be written. -
setPrintHeader
Sets whether to print out a header row in the results. By default an header is printed. -
setFieldDelimiter
Sets the delimiter to use between fields in the exported data. By default "," is used. -
setFormat
Sets the exported file format. If not set table is exported in CSV format. -
setCompression
Sets the compression value to use for exported files. If not set exported files are not compressed. -
setUseAvroLogicalTypes
[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 ornull
for none
-
setLabels
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 ornull
for none
-
setJobTimeoutMs
[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.- Parameters:
jobTimeoutMs
- jobTimeoutMs ornull
for none
-
build
Description copied from class:JobConfiguration.Builder
Creates an object.- Specified by:
build
in classJobConfiguration.Builder<ExtractJobConfiguration,
ExtractJobConfiguration.Builder>
-