
target.apidocs.com.google.api.services.bigquery.model.JobConfigurationExtract.html Maven / Gradle / Ivy
JobConfigurationExtract (BigQuery API v2-rev20190423-1.28.0)
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
-
public final class JobConfigurationExtract
extends com.google.api.client.json.GenericJson
Model definition for JobConfigurationExtract.
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>
-
Constructor Summary
Constructors
Constructor and Description
JobConfigurationExtract()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
JobConfigurationExtract
clone()
String
getCompression()
[Optional] The compression type to use for exported files.
String
getDestinationFormat()
[Optional] The exported file format.
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] Delimiter to use between fields in the exported data.
Boolean
getPrintHeader()
[Optional] Whether to print out a header row in the results.
TableReference
getSourceTable()
[Required] A reference to the table being exported.
boolean
isPrintHeader()
Convenience method that returns only Boolean.TRUE
or Boolean.FALSE
.
JobConfigurationExtract
set(String fieldName,
Object value)
JobConfigurationExtract
setCompression(String compression)
[Optional] The compression type to use for exported files.
JobConfigurationExtract
setDestinationFormat(String destinationFormat)
[Optional] The exported file format.
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] Delimiter to use between fields in the exported data.
JobConfigurationExtract
setPrintHeader(Boolean printHeader)
[Optional] Whether to print out a header row in the results.
JobConfigurationExtract
setSourceTable(TableReference sourceTable)
[Required] A reference to the table being exported.
-
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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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
-
-
Method Detail
-
getCompression
public String getCompression()
[Optional] The compression type to use for exported files. Possible values include GZIP,
DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for
Avro.
- Returns:
- value or
null
for none
-
setCompression
public JobConfigurationExtract setCompression(String compression)
[Optional] The compression type to use for exported files. Possible values include GZIP,
DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for
Avro.
- Parameters:
compression
- compression or null
for none
-
getDestinationFormat
public String getDestinationFormat()
[Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and
AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as
CSV.
- Returns:
- value or
null
for none
-
setDestinationFormat
public JobConfigurationExtract setDestinationFormat(String destinationFormat)
[Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and
AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as
CSV.
- 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] Delimiter to use between fields in the exported data. Default is ','
- Returns:
- value or
null
for none
-
setFieldDelimiter
public JobConfigurationExtract setFieldDelimiter(String fieldDelimiter)
[Optional] Delimiter to use between fields in the exported data. Default is ','
- Parameters:
fieldDelimiter
- fieldDelimiter or null
for none
-
getPrintHeader
public Boolean getPrintHeader()
[Optional] Whether to print out a header row in the results. Default is true.
- 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.
- 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.
-
getSourceTable
public TableReference getSourceTable()
[Required] A reference to the table being exported.
- Returns:
- value or
null
for none
-
setSourceTable
public JobConfigurationExtract setSourceTable(TableReference sourceTable)
[Required] A reference to the table being exported.
- Parameters:
sourceTable
- sourceTable 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
Copyright © 2011–2019 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy