Class ExtractJobConfiguration (2.5.1)

public final class ExtractJobConfiguration extends JobConfiguration

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

Inherited Members

JobConfiguration.getType()

JobConfiguration.toBuilder()

JobConfiguration.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	`Object`

Returns

Type	Description
boolean

Overrides

Object.equals(Object)

getCompression()

public String getCompression()

Returns the compression value of exported files.

Returns

Type	Description
String

getDestinationUris()

public List<String> getDestinationUris()

Returns the list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.

Returns

Type	Description
List<String>

getFieldDelimiter()

public String getFieldDelimiter()

Returns the delimiter used between fields in the exported data.

Returns

Type	Description
String

getFormat()

public String getFormat()

Returns the exported files format.

Returns

Type	Description
String

getJobTimeoutMs()

public Long getJobTimeoutMs()

Returns the timeout associated with this job

Returns

Type	Description
Long

getLabels()

public Map<String,String> getLabels()

Returns the labels associated with this job

Returns

Type	Description
Map<String,String>

getSourceModel()

public ModelId getSourceModel()

Returns the model to export.

Returns

Type	Description
ModelId

getSourceTable()

public TableId getSourceTable()

Returns the table to export.

Returns

Type	Description
TableId

getUseAvroLogicalTypes()

public Boolean getUseAvroLogicalTypes()

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

Returns

Type	Description
Boolean

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

Object.hashCode()

newBuilder(ModelId sourceModel, String destinationUri)

public static ExtractJobConfiguration.Builder newBuilder(ModelId sourceModel, String destinationUri)

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)

public static ExtractJobConfiguration.Builder newBuilder(ModelId sourceModel, 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)

public static ExtractJobConfiguration.Builder newBuilder(TableId sourceTable, String destinationUri)

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)

public static ExtractJobConfiguration.Builder newBuilder(TableId sourceTable, 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)

public static ExtractJobConfiguration of(ModelId sourceModel, String destinationUri)

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)

public static ExtractJobConfiguration of(ModelId sourceTable, String destinationUri, String format)

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)

public static ExtractJobConfiguration of(ModelId sourceModel, 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)

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

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)

public static ExtractJobConfiguration of(TableId sourceTable, String destinationUri)

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)

public static ExtractJobConfiguration of(TableId sourceTable, String destinationUri, String format)

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)

public static ExtractJobConfiguration of(TableId sourceTable, 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)

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

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

printHeader()

public Boolean printHeader()

Returns whether an header row is printed with the result.

Returns

Type	Description
Boolean

toBuilder()

public ExtractJobConfiguration.Builder toBuilder()

Returns a builder for the object.

Returns

Type	Description
ExtractJobConfiguration.Builder

Overrides

JobConfiguration.toBuilder()