com.google.cloud.bigquery.ExtractJobConfiguration Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-bigquery Show documentation
Show all versions of google-cloud-bigquery Show documentation
Java idiomatic client for Google Cloud BigQuery.
/*
* Copyright 2016 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.bigquery;
import static com.google.common.base.Preconditions.checkNotNull;
import com.google.api.services.bigquery.model.JobConfigurationExtract;
import com.google.common.base.MoreObjects.ToStringHelper;
import com.google.common.collect.ImmutableList;
import java.util.List;
import java.util.Objects;
/**
* 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 {@link JobConfiguration.Type#EXTRACT} type.
*/
public final class ExtractJobConfiguration extends JobConfiguration {
private static final long serialVersionUID = 4147749733166593761L;
private final TableId sourceTable;
private final List destinationUris;
private final Boolean printHeader;
private final String fieldDelimiter;
private final String format;
private final String compression;
public static final class Builder
extends JobConfiguration.Builder {
private TableId sourceTable;
private List destinationUris;
private Boolean printHeader;
private String fieldDelimiter;
private String format;
private String compression;
private Builder() {
super(Type.EXTRACT);
}
private Builder(ExtractJobConfiguration jobInfo) {
this();
this.sourceTable = jobInfo.sourceTable;
this.destinationUris = jobInfo.destinationUris;
this.printHeader = jobInfo.printHeader;
this.fieldDelimiter = jobInfo.fieldDelimiter;
this.format = jobInfo.format;
this.compression = jobInfo.compression;
}
private Builder(com.google.api.services.bigquery.model.JobConfiguration configurationPb) {
this();
JobConfigurationExtract extractConfigurationPb = configurationPb.getExtract();
this.sourceTable = TableId.fromPb(extractConfigurationPb.getSourceTable());
this.destinationUris = extractConfigurationPb.getDestinationUris();
this.printHeader = extractConfigurationPb.getPrintHeader();
this.fieldDelimiter = extractConfigurationPb.getFieldDelimiter();
this.format = extractConfigurationPb.getDestinationFormat();
this.compression = extractConfigurationPb.getCompression();
}
/**
* Sets the table to export.
*/
public Builder setSourceTable(TableId sourceTable) {
this.sourceTable = sourceTable;
return this;
}
/**
* Sets the list of fully-qualified Google Cloud Storage URIs (e.g. gs://bucket/path) where the
* extracted table should be written.
*/
public Builder setDestinationUris(List destinationUris) {
this.destinationUris = destinationUris != null ? ImmutableList.copyOf(destinationUris) : null;
return this;
}
/**
* Sets whether to print out a header row in the results. By default an header is printed.
*/
public Builder setPrintHeader(Boolean printHeader) {
this.printHeader = printHeader;
return this;
}
/**
* Sets the delimiter to use between fields in the exported data. By default "," is used.
*/
public Builder setFieldDelimiter(String fieldDelimiter) {
this.fieldDelimiter = fieldDelimiter;
return this;
}
/**
* Sets the exported file format. If not set table is exported in CSV format.
*
*
* Destination Format
*/
public Builder setFormat(String format) {
this.format = format;
return this;
}
/**
* Sets the compression value to use for exported files. If not set exported files are not
* compressed.
*
*
* Compression
*/
public Builder setCompression(String compression) {
this.compression = compression;
return this;
}
public ExtractJobConfiguration build() {
return new ExtractJobConfiguration(this);
}
}
private ExtractJobConfiguration(Builder builder) {
super(builder);
this.sourceTable = checkNotNull(builder.sourceTable);
this.destinationUris = checkNotNull(builder.destinationUris);
this.printHeader = builder.printHeader;
this.fieldDelimiter = builder.fieldDelimiter;
this.format = builder.format;
this.compression = builder.compression;
}
/**
* Returns the table to export.
*/
public TableId getSourceTable() {
return sourceTable;
}
/**
* Returns the list of fully-qualified Google Cloud Storage URIs where the extracted table should
* be written.
*
* @see
* Exporting Data Into One or More Files
*/
public List getDestinationUris() {
return destinationUris;
}
/**
* Returns whether an header row is printed with the result.
*/
public Boolean printHeader() {
return printHeader;
}
/**
* Returns the delimiter used between fields in the exported data.
*/
public String getFieldDelimiter() {
return fieldDelimiter;
}
/**
* Returns the exported files format.
*/
public String getFormat() {
return format;
}
/**
* Returns the compression value of exported files.
*/
public String getCompression() {
return compression;
}
@Override
public Builder toBuilder() {
return new Builder(this);
}
@Override
ToStringHelper toStringHelper() {
return super.toStringHelper()
.add("sourceTable", sourceTable)
.add("destinationUris", destinationUris)
.add("format", format)
.add("printHeader", printHeader)
.add("fieldDelimiter", fieldDelimiter)
.add("compression", compression);
}
@Override
public boolean equals(Object obj) {
return obj == this
|| obj instanceof ExtractJobConfiguration
&& baseEquals((ExtractJobConfiguration) obj);
}
@Override
public int hashCode() {
return Objects.hash(baseHashCode(), sourceTable, destinationUris, printHeader, fieldDelimiter,
format, compression);
}
@Override
ExtractJobConfiguration setProjectId(String projectId) {
return toBuilder().setSourceTable(getSourceTable().setProjectId(projectId)).build();
}
@Override
com.google.api.services.bigquery.model.JobConfiguration toPb() {
JobConfigurationExtract extractConfigurationPb = new JobConfigurationExtract();
extractConfigurationPb.setDestinationUris(destinationUris);
extractConfigurationPb.setSourceTable(sourceTable.toPb());
extractConfigurationPb.setPrintHeader(printHeader);
extractConfigurationPb.setFieldDelimiter(fieldDelimiter);
extractConfigurationPb.setDestinationFormat(format);
extractConfigurationPb.setCompression(compression);
return new com.google.api.services.bigquery.model.JobConfiguration()
.setExtract(extractConfigurationPb);
}
/**
* Creates a builder for a BigQuery Extract Job configuration given source table and destination
* URI.
*/
public static Builder newBuilder(TableId sourceTable, String destinationUri) {
return newBuilder(sourceTable, ImmutableList.of(checkNotNull(destinationUri)));
}
/**
* Creates a builder for a BigQuery Extract Job configuration given source table and destination
* URIs.
*/
public static Builder newBuilder(TableId sourceTable, List destinationUris) {
return new Builder().setSourceTable(sourceTable).setDestinationUris(destinationUris);
}
/**
* Returns a BigQuery Extract Job configuration for the given source table and destination URI.
*/
public static ExtractJobConfiguration of(TableId sourceTable, String destinationUri) {
return newBuilder(sourceTable, destinationUri).build();
}
/**
* Returns a BigQuery Extract Job configuration for the given source table and destination URIs.
*/
public static ExtractJobConfiguration of(TableId sourceTable, List destinationUris) {
return newBuilder(sourceTable, destinationUris).build();
}
/**
* Returns a BigQuery Extract Job configuration for the given source table, format and destination
* URI.
*/
public static ExtractJobConfiguration of(TableId sourceTable, String destinationUri,
String format) {
return newBuilder(sourceTable, destinationUri).setFormat(format).build();
}
/**
* Returns a BigQuery Extract Job configuration for the given source table, format and destination
* URIs.
*/
public static ExtractJobConfiguration of(TableId sourceTable, List destinationUris,
String format) {
return newBuilder(sourceTable, destinationUris).setFormat(format).build();
}
@SuppressWarnings("unchecked")
static ExtractJobConfiguration fromPb(
com.google.api.services.bigquery.model.JobConfiguration confPb) {
return new Builder(confPb).build();
}
}