com.google.cloud.bigquery.FormatOptions Maven / Gradle / Ivy

/*
 * 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 static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Strings.isNullOrEmpty;

import com.google.common.base.MoreObjects;
import java.io.Serializable;
import java.util.Objects;

/**
 * Base class for Google BigQuery format options. These class define the format of external data
 * used by BigQuery, for either federated tables or load jobs.
 *
 * Load jobs support the following formats: AVRO, CSV, DATASTORE_BACKUP, GOOGLE_SHEETS, JSON,
 * ORC, PARQUET
 *
 * Federated tables can be defined against following formats: AVRO, BIGTABLE, CSV,
 * DATASTORE_BACKUP, GOOGLE_SHEETS, JSON
 */
public class FormatOptions implements Serializable {

  static final String CSV = "CSV";
  static final String JSON = "NEWLINE_DELIMITED_JSON";
  static final String BIGTABLE = "BIGTABLE";
  static final String DATASTORE_BACKUP = "DATASTORE_BACKUP";
  static final String AVRO = "AVRO";
  static final String GOOGLE_SHEETS = "GOOGLE_SHEETS";
  static final String PARQUET = "PARQUET";
  static final String ORC = "ORC";

  private static final long serialVersionUID = -443376052020423691L;

  private final String type;

  FormatOptions(String type) {
    this.type = type;
  }

  /** Returns the external data format, as a string. */
  public String getType() {
    return type;
  }

  @Override
  public String toString() {
    return MoreObjects.toStringHelper(this).add("format", type).toString();
  }

  @Override
  public int hashCode() {
    return Objects.hash(type);
  }

  @Override
  public boolean equals(Object obj) {
    return obj == this
        || obj != null
            && obj.getClass().equals(FormatOptions.class)
            && Objects.equals(type, ((FormatOptions) obj).getType());
  }

  /** Default options for CSV format. */
  public static CsvOptions csv() {
    return CsvOptions.newBuilder().build();
  }

  /** Default options for NEWLINE_DELIMITED_JSON format. */
  public static FormatOptions json() {
    return new FormatOptions(JSON);
  }

  /** Default options for DATASTORE_BACKUP format. */
  public static FormatOptions datastoreBackup() {
    return DatastoreBackupOptions.newBuilder().build();
  }

  /** Default options for AVRO format. */
  public static AvroOptions avro() {
    return AvroOptions.newBuilder().build();
  }

  /** Default options for BIGTABLE format. */
  public static FormatOptions bigtable() {
    return BigtableOptions.newBuilder().build();
  }

  /** Default options for GOOGLE_SHEETS format. */
  public static FormatOptions googleSheets() {
    return GoogleSheetsOptions.newBuilder().build();
  }

  /** Default options for PARQUET format. */
  public static FormatOptions parquet() {
    return new FormatOptions(PARQUET);
  }

  /** Default options for the ORC format. */
  public static FormatOptions orc() {
    return new FormatOptions(ORC);
  }

  /** Default options for the provided format. */
  public static FormatOptions of(String format) {
    checkArgument(!isNullOrEmpty(format), "Provided format is null or empty");
    if (format.equals(CSV)) {
      return csv();
    } else if (format.equals(AVRO)) {
      return avro();
    } else if (format.equals(DATASTORE_BACKUP)) {
      return datastoreBackup();
    } else if (format.equals(GOOGLE_SHEETS)) {
      return googleSheets();
    } else if (format.equals(BIGTABLE)) {
      return bigtable();
    } else if (format.equals(PARQUET)) {
      return parquet();
    }
    return new FormatOptions(format);
  }
}