com.google.api.services.bigquery.model.CsvOptions Maven / Gradle / Ivy
/*
* Copyright 2010 Google Inc.
*
* 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.
*/
/*
* This code was generated by https://github.com/google/apis-client-generator/
* (build: 2018-05-04 17:28:03 UTC)
* on 2018-06-01 at 07:28:28 UTC
* Modify at your own risk.
*/
package com.google.api.services.bigquery.model;
/**
* Model definition for CsvOptions.
*
* 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.
*/
@SuppressWarnings("javadoc")
public final class CsvOptions extends com.google.api.client.json.GenericJson {
/**
* [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns.
* If true, BigQuery treats missing trailing columns as null values. If 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. The default value is false.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean allowJaggedRows;
/**
* [Optional] Indicates if BigQuery should allow quoted data sections that contain newline
* characters in a CSV file. The default value is false.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.Boolean allowQuotedNewlines;
/**
* [Optional] 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 of the quote and fieldDelimiter properties.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String encoding;
/**
* [Optional] 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 (',').
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String fieldDelimiter;
/**
* [Optional] 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 the allowQuotedNewlines property to true.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String quote;
/**
* [Optional] 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.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key @com.google.api.client.json.JsonString
private java.lang.Long skipLeadingRows;
/**
* [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns.
* If true, BigQuery treats missing trailing columns as null values. If 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. The default value is false.
* @return value or {@code null} for none
*/
public java.lang.Boolean getAllowJaggedRows() {
return allowJaggedRows;
}
/**
* [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns.
* If true, BigQuery treats missing trailing columns as null values. If 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. The default value is false.
* @param allowJaggedRows allowJaggedRows or {@code null} for none
*/
public CsvOptions setAllowJaggedRows(java.lang.Boolean allowJaggedRows) {
this.allowJaggedRows = allowJaggedRows;
return this;
}
/**
* [Optional] Indicates if BigQuery should allow quoted data sections that contain newline
* characters in a CSV file. The default value is false.
* @return value or {@code null} for none
*/
public java.lang.Boolean getAllowQuotedNewlines() {
return allowQuotedNewlines;
}
/**
* [Optional] Indicates if BigQuery should allow quoted data sections that contain newline
* characters in a CSV file. The default value is false.
* @param allowQuotedNewlines allowQuotedNewlines or {@code null} for none
*/
public CsvOptions setAllowQuotedNewlines(java.lang.Boolean allowQuotedNewlines) {
this.allowQuotedNewlines = allowQuotedNewlines;
return this;
}
/**
* [Optional] 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 of the quote and fieldDelimiter properties.
* @return value or {@code null} for none
*/
public java.lang.String getEncoding() {
return encoding;
}
/**
* [Optional] 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 of the quote and fieldDelimiter properties.
* @param encoding encoding or {@code null} for none
*/
public CsvOptions setEncoding(java.lang.String encoding) {
this.encoding = encoding;
return this;
}
/**
* [Optional] 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 (',').
* @return value or {@code null} for none
*/
public java.lang.String getFieldDelimiter() {
return fieldDelimiter;
}
/**
* [Optional] 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 (',').
* @param fieldDelimiter fieldDelimiter or {@code null} for none
*/
public CsvOptions setFieldDelimiter(java.lang.String fieldDelimiter) {
this.fieldDelimiter = fieldDelimiter;
return this;
}
/**
* [Optional] 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 the allowQuotedNewlines property to true.
* @return value or {@code null} for none
*/
public java.lang.String getQuote() {
return quote;
}
/**
* [Optional] 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 the allowQuotedNewlines property to true.
* @param quote quote or {@code null} for none
*/
public CsvOptions setQuote(java.lang.String quote) {
this.quote = quote;
return this;
}
/**
* [Optional] 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.
* @return value or {@code null} for none
*/
public java.lang.Long getSkipLeadingRows() {
return skipLeadingRows;
}
/**
* [Optional] 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.
* @param skipLeadingRows skipLeadingRows or {@code null} for none
*/
public CsvOptions setSkipLeadingRows(java.lang.Long skipLeadingRows) {
this.skipLeadingRows = skipLeadingRows;
return this;
}
@Override
public CsvOptions set(String fieldName, Object value) {
return (CsvOptions) super.set(fieldName, value);
}
@Override
public CsvOptions clone() {
return (CsvOptions) super.clone();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy