Class ExtractJobConfiguration (2.50.1) 

publicfinalclass ExtractJobConfigurationextendsJobConfiguration

Google BigQuery extract job configuration. An extract job exports a BigQuery table to Google Cloud Storage. The extract destination provided as URIs that point to objects in Google Cloud Storage. Extract job configurations have JobConfiguration.Type#EXTRACT type.

Inheritance

Object > JobConfiguration > ExtractJobConfiguration

Static Methods

newBuilder(ModelId sourceModel, String destinationUri)

publicstaticExtractJobConfiguration.BuildernewBuilder(ModelIdsourceModel,StringdestinationUri)

Creates a builder for a BigQuery Extract Job configuration given source model and destination URI.

Parameters
Name Description
sourceModel ModelId
destinationUri String
Returns
Type Description
ExtractJobConfiguration.Builder

newBuilder(ModelId sourceModel, List<String> destinationUris)

publicstaticExtractJobConfiguration.BuildernewBuilder(ModelIdsourceModel,List<String>destinationUris)

Creates a builder for a BigQuery Extract Job configuration given source model and destination URIs.

Parameters
Name Description
sourceModel ModelId
destinationUris List<String>
Returns
Type Description
ExtractJobConfiguration.Builder

newBuilder(TableId sourceTable, String destinationUri)

publicstaticExtractJobConfiguration.BuildernewBuilder(TableIdsourceTable,StringdestinationUri)

Creates a builder for a BigQuery Extract Job configuration given source table and destination URI.

Parameters
Name Description
sourceTable TableId
destinationUri String
Returns
Type Description
ExtractJobConfiguration.Builder

newBuilder(TableId sourceTable, List<String> destinationUris)

publicstaticExtractJobConfiguration.BuildernewBuilder(TableIdsourceTable,List<String>destinationUris)

Creates a builder for a BigQuery Extract Job configuration given source table and destination URIs.

Parameters
Name Description
sourceTable TableId
destinationUris List<String>
Returns
Type Description
ExtractJobConfiguration.Builder

of(ModelId sourceModel, String destinationUri)

publicstaticExtractJobConfigurationof(ModelIdsourceModel,StringdestinationUri)

Returns a BigQuery Extract Job configuration for the given source model and destination URI.

Parameters
Name Description
sourceModel ModelId
destinationUri String
Returns
Type Description
ExtractJobConfiguration

of(ModelId sourceTable, String destinationUri, String format)

publicstaticExtractJobConfigurationof(ModelIdsourceTable,StringdestinationUri,Stringformat)

Returns a BigQuery Extract Job configuration for the given source model, format and destination URI.

Parameters
Name Description
sourceTable ModelId
destinationUri String
format String
Returns
Type Description
ExtractJobConfiguration

of(ModelId sourceModel, List<String> destinationUris)

publicstaticExtractJobConfigurationof(ModelIdsourceModel,List<String>destinationUris)

Returns a BigQuery Extract Job configuration for the given source model and destination URIs.

Parameters
Name Description
sourceModel ModelId
destinationUris List<String>
Returns
Type Description
ExtractJobConfiguration

of(ModelId sourceModel, List<String> destinationUris, String format)

publicstaticExtractJobConfigurationof(ModelIdsourceModel,List<String>destinationUris,Stringformat)

Returns a BigQuery Extract Job configuration for the given source table, format and destination URIs.

Parameters
Name Description
sourceModel ModelId
destinationUris List<String>
format String
Returns
Type Description
ExtractJobConfiguration

of(TableId sourceTable, String destinationUri)

publicstaticExtractJobConfigurationof(TableIdsourceTable,StringdestinationUri)

Returns a BigQuery Extract Job configuration for the given source table and destination URI.

Parameters
Name Description
sourceTable TableId
destinationUri String
Returns
Type Description
ExtractJobConfiguration

of(TableId sourceTable, String destinationUri, String format)

publicstaticExtractJobConfigurationof(TableIdsourceTable,StringdestinationUri,Stringformat)

Returns a BigQuery Extract Job configuration for the given source table, format and destination URI.

Parameters
Name Description
sourceTable TableId
destinationUri String
format String
Returns
Type Description
ExtractJobConfiguration

of(TableId sourceTable, List<String> destinationUris)

publicstaticExtractJobConfigurationof(TableIdsourceTable,List<String>destinationUris)

Returns a BigQuery Extract Job configuration for the given source table and destination URIs.

Parameters
Name Description
sourceTable TableId
destinationUris List<String>
Returns
Type Description
ExtractJobConfiguration

of(TableId sourceTable, List<String> destinationUris, String format)

publicstaticExtractJobConfigurationof(TableIdsourceTable,List<String>destinationUris,Stringformat)

Returns a BigQuery Extract Job configuration for the given source table, format and destination URIs.

Parameters
Name Description
sourceTable TableId
destinationUris List<String>
format String
Returns
Type Description
ExtractJobConfiguration

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCompression()

publicStringgetCompression()

Returns the compression value of exported files.

Returns
Type Description
String

getDestinationUris()

publicList<String>getDestinationUris()

Returns the list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. See Also: Exporting Data Into One or More Files

Returns
Type Description
List<String>

getFieldDelimiter()

publicStringgetFieldDelimiter()

Returns the delimiter used between fields in the exported data.

Returns
Type Description
String

getFormat()

publicStringgetFormat()

Returns the exported files format.

Returns
Type Description
String

getJobTimeoutMs()

publicLonggetJobTimeoutMs()

Returns the timeout associated with this job

Returns
Type Description
Long

getLabels()

publicMap<String,String>getLabels()

Returns the labels associated with this job

Returns
Type Description
Map<String,String>

getReservation()

publicStringgetReservation()

Returns the reservation associated with this job

Returns
Type Description
String

getSourceModel()

publicModelIdgetSourceModel()

Returns the model to export.

Returns
Type Description
ModelId

getSourceTable()

publicTableIdgetSourceTable()

Returns the table to export.

Returns
Type Description
TableId

getUseAvroLogicalTypes()

publicBooleangetUseAvroLogicalTypes()

Returns True/False. Indicates whether exported avro files include logical type annotations.

Returns
Type Description
Boolean

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

printHeader()

publicBooleanprintHeader()

Returns whether an header row is printed with the result.

Returns
Type Description
Boolean

toBuilder()

publicExtractJobConfiguration.BuildertoBuilder()

Returns a builder for the object.

Returns
Type Description
ExtractJobConfiguration.Builder
Overrides

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.