Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2015 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 com.google.common.base.MoreObjects;
import java.nio.charset.Charset;
import java.util.Objects;
/**
* Google BigQuery options for CSV format. This class wraps some properties of CSV files used by
* BigQuery to parse external data.
*/
public final class CsvOptions extends FormatOptions {
private static final long serialVersionUID = 2193570529308612708L;
private final Boolean allowJaggedRows;
private final Boolean allowQuotedNewLines;
private final String encoding;
private final String fieldDelimiter;
private final String quote;
private final Long skipLeadingRows;
private final Boolean preserveAsciiControlCharacters;
public static final class Builder {
private Boolean allowJaggedRows;
private Boolean allowQuotedNewLines;
private String encoding;
private String fieldDelimiter;
private String quote;
private Long skipLeadingRows;
private Boolean preserveAsciiControlCharacters;
private Builder() {}
private Builder(CsvOptions csvOptions) {
this.allowJaggedRows = csvOptions.allowJaggedRows;
this.allowQuotedNewLines = csvOptions.allowQuotedNewLines;
this.encoding = csvOptions.encoding;
this.fieldDelimiter = csvOptions.fieldDelimiter;
this.quote = csvOptions.quote;
this.skipLeadingRows = csvOptions.skipLeadingRows;
this.preserveAsciiControlCharacters = csvOptions.preserveAsciiControlCharacters;
}
/**
* Set whether BigQuery should accept rows that are missing trailing optional columns. If {@code
* true}, BigQuery treats missing trailing columns as null values. If {@code false}, records
* with missing trailing columns are treated as bad records, and if there are too many bad
* records, an invalid error is returned in the job result. By default, rows with missing
* trailing columns are considered bad records.
*/
public Builder setAllowJaggedRows(boolean allowJaggedRows) {
this.allowJaggedRows = allowJaggedRows;
return this;
}
/**
* Sets whether BigQuery should allow quoted data sections that contain newline characters in a
* CSV file. By default quoted newline are not allowed.
*/
public Builder setAllowQuotedNewLines(boolean allowQuotedNewLines) {
this.allowQuotedNewLines = allowQuotedNewLines;
return this;
}
/**
* Sets the character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The
* default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split
* using the values set in {@link #setQuote(String)} and {@link #setFieldDelimiter(String)}.
*/
public Builder setEncoding(String encoding) {
this.encoding = encoding;
return this;
}
/**
* Sets the character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The
* default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split
* using the values set in {@link #setQuote(String)} and {@link #setFieldDelimiter(String)}.
*/
public Builder setEncoding(Charset encoding) {
this.encoding = encoding.name();
return this;
}
/**
* Sets the separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1
* encoding, and then uses the first byte of the encoded string to split the data in its raw,
* binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The
* default value is a comma (',').
*/
public Builder setFieldDelimiter(String fieldDelimiter) {
this.fieldDelimiter = fieldDelimiter;
return this;
}
/**
* Sets the value that is used to quote data sections in a CSV file. BigQuery converts the
* string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split
* the data in its raw, binary state. The default value is a double-quote ('"'). If your data
* does not contain quoted sections, set the property value to an empty string. If your data
* contains quoted newline characters, you must also set {@link
* #setAllowQuotedNewLines(boolean)} property to {@code true}.
*/
public Builder setQuote(String quote) {
this.quote = quote;
return this;
}
/**
* Sets the number of rows at the top of a CSV file that BigQuery will skip when reading the
* data. The default value is 0. This property is useful if you have header rows in the file
* that should be skipped.
*/
public Builder setSkipLeadingRows(long skipLeadingRows) {
this.skipLeadingRows = skipLeadingRows;
return this;
}
/**
* Sets whether BigQuery should allow ASCII control characters in a CSV file. By default ASCII
* control characters are not allowed.
*/
public Builder setPreserveAsciiControlCharacters(boolean preserveAsciiControlCharacters) {
this.preserveAsciiControlCharacters = preserveAsciiControlCharacters;
return this;
}
/** Creates a {@code CsvOptions} object. */
public CsvOptions build() {
return new CsvOptions(this);
}
}
private CsvOptions(Builder builder) {
super(FormatOptions.CSV);
this.allowJaggedRows = builder.allowJaggedRows;
this.allowQuotedNewLines = builder.allowQuotedNewLines;
this.encoding = builder.encoding;
this.fieldDelimiter = builder.fieldDelimiter;
this.quote = builder.quote;
this.skipLeadingRows = builder.skipLeadingRows;
this.preserveAsciiControlCharacters = builder.preserveAsciiControlCharacters;
}
/**
* Returns whether BigQuery should accept rows that are missing trailing optional columns. If
* {@code true}, BigQuery treats missing trailing columns as null values. If {@code false},
* records with missing trailing columns are treated as bad records, and if the number of bad
* records exceeds {@link ExternalTableDefinition#getMaxBadRecords()}, an invalid error is
* returned in the job result.
*/
public Boolean allowJaggedRows() {
return allowJaggedRows;
}
/**
* Returns whether BigQuery should allow quoted data sections that contain newline characters in a
* CSV file.
*/
public Boolean allowQuotedNewLines() {
return allowQuotedNewLines;
}
/**
* Returns the character encoding of the data. The supported values are UTF-8 or ISO-8859-1. If
* not set, UTF-8 is used. BigQuery decodes the data after the raw, binary data has been split
* using the values set in {@link #getQuote()} and {@link #getFieldDelimiter()}.
*/
public String getEncoding() {
return encoding;
}
/** Returns the separator for fields in a CSV file. */
public String getFieldDelimiter() {
return fieldDelimiter;
}
/** Returns the value that is used to quote data sections in a CSV file. */
public String getQuote() {
return quote;
}
/**
* Returns the number of rows at the top of a CSV file that BigQuery will skip when reading the
* data.
*/
public Long getSkipLeadingRows() {
return skipLeadingRows;
}
/**
* Returns whether BigQuery should allow ascii control characters in a CSV file. By default ascii
* control characters are not allowed.
*/
public Boolean getPreserveAsciiControlCharacters() {
return preserveAsciiControlCharacters;
}
/** Returns a builder for the {@code CsvOptions} object. */
public Builder toBuilder() {
return new Builder(this);
}
@Override
public String toString() {
return MoreObjects.toStringHelper(this)
.add("type", getType())
.add("allowJaggedRows", allowJaggedRows)
.add("allowQuotedNewLines", allowQuotedNewLines)
.add("encoding", encoding)
.add("fieldDelimiter", fieldDelimiter)
.add("quote", quote)
.add("skipLeadingRows", skipLeadingRows)
.add("preserveAsciiControlCharacters", preserveAsciiControlCharacters)
.toString();
}
@Override
public int hashCode() {
return Objects.hash(
getType(),
allowJaggedRows,
allowQuotedNewLines,
encoding,
fieldDelimiter,
quote,
skipLeadingRows,
preserveAsciiControlCharacters);
}
@Override
public boolean equals(Object obj) {
return obj == this
|| obj instanceof CsvOptions && Objects.equals(toPb(), ((CsvOptions) obj).toPb());
}
com.google.api.services.bigquery.model.CsvOptions toPb() {
com.google.api.services.bigquery.model.CsvOptions csvOptions =
new com.google.api.services.bigquery.model.CsvOptions();
csvOptions.setAllowJaggedRows(allowJaggedRows);
csvOptions.setAllowQuotedNewlines(allowQuotedNewLines);
csvOptions.setEncoding(encoding);
csvOptions.setFieldDelimiter(fieldDelimiter);
csvOptions.setQuote(quote);
csvOptions.setSkipLeadingRows(skipLeadingRows);
csvOptions.setPreserveAsciiControlCharacters(preserveAsciiControlCharacters);
return csvOptions;
}
/** Returns a builder for a CsvOptions object. */
public static Builder newBuilder() {
return new Builder();
}
static CsvOptions fromPb(com.google.api.services.bigquery.model.CsvOptions csvOptions) {
Builder builder = newBuilder();
if (csvOptions.getAllowJaggedRows() != null) {
builder.setAllowJaggedRows(csvOptions.getAllowJaggedRows());
}
if (csvOptions.getAllowQuotedNewlines() != null) {
builder.setAllowQuotedNewLines(csvOptions.getAllowQuotedNewlines());
}
if (csvOptions.getEncoding() != null) {
builder.setEncoding(csvOptions.getEncoding());
}
if (csvOptions.getFieldDelimiter() != null) {
builder.setFieldDelimiter(csvOptions.getFieldDelimiter());
}
if (csvOptions.getQuote() != null) {
builder.setQuote(csvOptions.getQuote());
}
if (csvOptions.getSkipLeadingRows() != null) {
builder.setSkipLeadingRows(csvOptions.getSkipLeadingRows());
}
if (csvOptions.getPreserveAsciiControlCharacters() != null) {
builder.setPreserveAsciiControlCharacters(csvOptions.getPreserveAsciiControlCharacters());
}
return builder.build();
}
}
