com.google.api.services.bigquery.model.ExternalCatalogTableOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-bigquery Show documentation
There is a newer version: v2-rev20241222-2.0.0
Show newest version
/*
 * 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/googleapis/google-api-java-client-services/
 * Modify at your own risk.
 */

package com.google.api.services.bigquery.model;

/**
 * Metadata about open source compatible table. The fields contained in these options correspond to
 * hive metastore's table level properties.
 *
 *  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 ExternalCatalogTableOptions extends com.google.api.client.json.GenericJson {

  /**
   * Optional. The connection specifying the credentials to be used to read external storage, such
   * as Azure Blob, Cloud Storage, or S3. The connection is needed to read the open source table
   * from BigQuery Engine. The connection_id can have the form `..` or
   * `projects//locations//connections/`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String connectionId;

  /**
   * Optional. A map of key value pairs defining the parameters and properties of the open source
   * table. Corresponds with hive meta store table parameters. Maximum size of 4Mib.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.Map parameters;

  /**
   * Optional. A storage descriptor containing information about the physical storage of this table.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private StorageDescriptor storageDescriptor;

  /**
   * Optional. The connection specifying the credentials to be used to read external storage, such
   * as Azure Blob, Cloud Storage, or S3. The connection is needed to read the open source table
   * from BigQuery Engine. The connection_id can have the form `..` or
   * `projects//locations//connections/`.
   * @return value or {@code null} for none
   */
  public java.lang.String getConnectionId() {
    return connectionId;
  }

  /**
   * Optional. The connection specifying the credentials to be used to read external storage, such
   * as Azure Blob, Cloud Storage, or S3. The connection is needed to read the open source table
   * from BigQuery Engine. The connection_id can have the form `..` or
   * `projects//locations//connections/`.
   * @param connectionId connectionId or {@code null} for none
   */
  public ExternalCatalogTableOptions setConnectionId(java.lang.String connectionId) {
    this.connectionId = connectionId;
    return this;
  }

  /**
   * Optional. A map of key value pairs defining the parameters and properties of the open source
   * table. Corresponds with hive meta store table parameters. Maximum size of 4Mib.
   * @return value or {@code null} for none
   */
  public java.util.Map getParameters() {
    return parameters;
  }

  /**
   * Optional. A map of key value pairs defining the parameters and properties of the open source
   * table. Corresponds with hive meta store table parameters. Maximum size of 4Mib.
   * @param parameters parameters or {@code null} for none
   */
  public ExternalCatalogTableOptions setParameters(java.util.Map parameters) {
    this.parameters = parameters;
    return this;
  }

  /**
   * Optional. A storage descriptor containing information about the physical storage of this table.
   * @return value or {@code null} for none
   */
  public StorageDescriptor getStorageDescriptor() {
    return storageDescriptor;
  }

  /**
   * Optional. A storage descriptor containing information about the physical storage of this table.
   * @param storageDescriptor storageDescriptor or {@code null} for none
   */
  public ExternalCatalogTableOptions setStorageDescriptor(StorageDescriptor storageDescriptor) {
    this.storageDescriptor = storageDescriptor;
    return this;
  }

  @Override
  public ExternalCatalogTableOptions set(String fieldName, Object value) {
    return (ExternalCatalogTableOptions) super.set(fieldName, value);
  }

  @Override
  public ExternalCatalogTableOptions clone() {
    return (ExternalCatalogTableOptions) super.clone();
  }

}