com.google.api.services.logging.v2.model.BigQueryOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-logging Show documentation
There is a newer version: v2-rev20241018-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.logging.v2.model;

/**
 * Options that change functionality of a sink exporting data to BigQuery.
 *
 *  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 Cloud Logging 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 BigQueryOptions extends com.google.api.client.json.GenericJson {

  /**
   * Optional. Whether to use BigQuery's partition tables (https://cloud.google.com/bigquery/docs
   * /partitioned-tables). By default, Cloud Logging creates dated tables based on the log entries'
   * timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present
   * and special query syntax (https://cloud.google.com/bigquery/docs/querying-partitioned-tables)
   * has to be used instead. In both cases, tables are sharded based on UTC timezone.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean usePartitionedTables;

  /**
   * Output only. True if new timestamp column based partitioning is in use, false if legacy
   * ingress-time partitioning is in use.All new sinks will have this field set true and will use
   * timestamp column based partitioning. If use_partitioned_tables is false, this value has no
   * meaning and will be false. Legacy sinks using partitioned tables will have this field set to
   * false.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.Boolean usesTimestampColumnPartitioning;

  /**
   * Optional. Whether to use BigQuery's partition tables (https://cloud.google.com/bigquery/docs
   * /partitioned-tables). By default, Cloud Logging creates dated tables based on the log entries'
   * timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present
   * and special query syntax (https://cloud.google.com/bigquery/docs/querying-partitioned-tables)
   * has to be used instead. In both cases, tables are sharded based on UTC timezone.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getUsePartitionedTables() {
    return usePartitionedTables;
  }

  /**
   * Optional. Whether to use BigQuery's partition tables (https://cloud.google.com/bigquery/docs
   * /partitioned-tables). By default, Cloud Logging creates dated tables based on the log entries'
   * timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present
   * and special query syntax (https://cloud.google.com/bigquery/docs/querying-partitioned-tables)
   * has to be used instead. In both cases, tables are sharded based on UTC timezone.
   * @param usePartitionedTables usePartitionedTables or {@code null} for none
   */
  public BigQueryOptions setUsePartitionedTables(java.lang.Boolean usePartitionedTables) {
    this.usePartitionedTables = usePartitionedTables;
    return this;
  }

  /**
   * Output only. True if new timestamp column based partitioning is in use, false if legacy
   * ingress-time partitioning is in use.All new sinks will have this field set true and will use
   * timestamp column based partitioning. If use_partitioned_tables is false, this value has no
   * meaning and will be false. Legacy sinks using partitioned tables will have this field set to
   * false.
   * @return value or {@code null} for none
   */
  public java.lang.Boolean getUsesTimestampColumnPartitioning() {
    return usesTimestampColumnPartitioning;
  }

  /**
   * Output only. True if new timestamp column based partitioning is in use, false if legacy
   * ingress-time partitioning is in use.All new sinks will have this field set true and will use
   * timestamp column based partitioning. If use_partitioned_tables is false, this value has no
   * meaning and will be false. Legacy sinks using partitioned tables will have this field set to
   * false.
   * @param usesTimestampColumnPartitioning usesTimestampColumnPartitioning or {@code null} for none
   */
  public BigQueryOptions setUsesTimestampColumnPartitioning(java.lang.Boolean usesTimestampColumnPartitioning) {
    this.usesTimestampColumnPartitioning = usesTimestampColumnPartitioning;
    return this;
  }

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

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

}