com.google.api.services.bigquery.model

Class JobConfigurationExtract

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.bigquery.model.JobConfigurationExtract

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class JobConfigurationExtract
extends com.google.api.client.json.GenericJson

JobConfigurationExtract configures a job that exports data from a BigQuery table into Google Cloud Storage.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the BigQuery API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
JobConfigurationExtract()

Method Summary

Modifier and Type	Method and Description
JobConfigurationExtract	clone()
String	getCompression() Optional.
String	getDestinationFormat() Optional.
String	getDestinationUri() [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary.
List<String>	getDestinationUris() [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
String	getFieldDelimiter() Optional.
ModelExtractOptions	getModelExtractOptions() Optional.
Boolean	getPrintHeader() Optional.
ModelReference	getSourceModel() A reference to the model being exported.
TableReference	getSourceTable() A reference to the table being exported.
Boolean	getUseAvroLogicalTypes() Whether to use logical types when extracting to AVRO format.
boolean	isPrintHeader() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
JobConfigurationExtract	set(String fieldName, Object value)
JobConfigurationExtract	setCompression(String compression) Optional.
JobConfigurationExtract	setDestinationFormat(String destinationFormat) Optional.
JobConfigurationExtract	setDestinationUri(String destinationUri) [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary.
JobConfigurationExtract	setDestinationUris(List<String> destinationUris) [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
JobConfigurationExtract	setFieldDelimiter(String fieldDelimiter) Optional.
JobConfigurationExtract	setModelExtractOptions(ModelExtractOptions modelExtractOptions) Optional.
JobConfigurationExtract	setPrintHeader(Boolean printHeader) Optional.
JobConfigurationExtract	setSourceModel(ModelReference sourceModel) A reference to the model being exported.
JobConfigurationExtract	setSourceTable(TableReference sourceTable) A reference to the table being exported.
JobConfigurationExtract	setUseAvroLogicalTypes(Boolean useAvroLogicalTypes) Whether to use logical types when extracting to AVRO format.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

JobConfigurationExtract

public JobConfigurationExtract()

Method Detail

getCompression

public String getCompression()

Optional. The compression type to use for exported files. Possible values include DEFLATE, GZIP, NONE, SNAPPY, and ZSTD. The default value is NONE. Not all compression formats are support for all file formats. DEFLATE is only supported for Avro. ZSTD is only supported for Parquet. Not applicable when extracting models.

Returns:

value or null for none

setCompression

public JobConfigurationExtract setCompression(String compression)

Optional. The compression type to use for exported files. Possible values include DEFLATE, GZIP, NONE, SNAPPY, and ZSTD. The default value is NONE. Not all compression formats are support for all file formats. DEFLATE is only supported for Avro. ZSTD is only supported for Parquet. Not applicable when extracting models.

Parameters:

compression - compression or null for none

getDestinationFormat

public String getDestinationFormat()

Optional. The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET, or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.

Returns:

value or null for none

setDestinationFormat

public JobConfigurationExtract setDestinationFormat(String destinationFormat)

Optional. The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET, or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.

Parameters:

destinationFormat - destinationFormat or null for none

getDestinationUri

public String getDestinationUri()

[Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.

Returns:

value or null for none

setDestinationUri

public JobConfigurationExtract setDestinationUri(String destinationUri)

[Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.

Parameters:

destinationUri - destinationUri or null for none

getDestinationUris

public List<String> getDestinationUris()

[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.

Returns:

value or null for none

setDestinationUris

public JobConfigurationExtract setDestinationUris(List<String> destinationUris)

[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.

Parameters:

destinationUris - destinationUris or null for none

getFieldDelimiter

public String getFieldDelimiter()

Optional. When extracting data in CSV format, this defines the delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.

Returns:

value or null for none

setFieldDelimiter

public JobConfigurationExtract setFieldDelimiter(String fieldDelimiter)

Optional. When extracting data in CSV format, this defines the delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.

Parameters:

fieldDelimiter - fieldDelimiter or null for none

getModelExtractOptions

public ModelExtractOptions getModelExtractOptions()

Optional. Model extract options only applicable when extracting models.

Returns:

value or null for none

setModelExtractOptions

public JobConfigurationExtract setModelExtractOptions(ModelExtractOptions modelExtractOptions)

Optional. Model extract options only applicable when extracting models.

Parameters:

modelExtractOptions - modelExtractOptions or null for none

getPrintHeader

public Boolean getPrintHeader()

Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models.

Returns:

value or null for none

setPrintHeader

public JobConfigurationExtract setPrintHeader(Boolean printHeader)

Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models.

Parameters:

printHeader - printHeader or null for none

isPrintHeader

public boolean isPrintHeader()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models.

getSourceModel

public ModelReference getSourceModel()

A reference to the model being exported.

Returns:

value or null for none

setSourceModel

public JobConfigurationExtract setSourceModel(ModelReference sourceModel)

A reference to the model being exported.

Parameters:

sourceModel - sourceModel or null for none

getSourceTable

public TableReference getSourceTable()

A reference to the table being exported.

Returns:

value or null for none

setSourceTable

public JobConfigurationExtract setSourceTable(TableReference sourceTable)

A reference to the table being exported.

Parameters:

sourceTable - sourceTable or null for none

getUseAvroLogicalTypes

public Boolean getUseAvroLogicalTypes()

Whether to use logical types when extracting to AVRO format. Not applicable when extracting models.

Returns:

value or null for none

setUseAvroLogicalTypes

public JobConfigurationExtract setUseAvroLogicalTypes(Boolean useAvroLogicalTypes)

Whether to use logical types when extracting to AVRO format. Not applicable when extracting models.

Parameters:

useAvroLogicalTypes - useAvroLogicalTypes or null for none

set

public JobConfigurationExtract set(String fieldName,
                                   Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public JobConfigurationExtract clone()

Overrides:

clone in class com.google.api.client.json.GenericJson