com.google.api.services.datastream.v1.model.DatasetTemplate Maven / Gradle / Ivy

Go to download
/*
 * 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.datastream.v1.model;

/**
 * Dataset template used for dynamic dataset creation.
 *
 *  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 Datastream 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 DatasetTemplate extends com.google.api.client.json.GenericJson {

  /**
   * If supplied, every created dataset will have its name prefixed by the provided value. The
   * prefix and name will be separated by an underscore. i.e. _.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String datasetIdPrefix;

  /**
   * Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table.
   * The BigQuery Service Account associated with your project requires access to this encryption
   * key. i.e. projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{cryptoKey}.
   * See https://cloud.google.com/bigquery/docs/customer-managed-encryption for more information.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String kmsKeyName;

  /**
   * Required. The geographic location where the dataset should reside. See
   * https://cloud.google.com/bigquery/docs/locations for supported locations.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String location;

  /**
   * If supplied, every created dataset will have its name prefixed by the provided value. The
   * prefix and name will be separated by an underscore. i.e. _.
   * @return value or {@code null} for none
   */
  public java.lang.String getDatasetIdPrefix() {
    return datasetIdPrefix;
  }

  /**
   * If supplied, every created dataset will have its name prefixed by the provided value. The
   * prefix and name will be separated by an underscore. i.e. _.
   * @param datasetIdPrefix datasetIdPrefix or {@code null} for none
   */
  public DatasetTemplate setDatasetIdPrefix(java.lang.String datasetIdPrefix) {
    this.datasetIdPrefix = datasetIdPrefix;
    return this;
  }

  /**
   * Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table.
   * The BigQuery Service Account associated with your project requires access to this encryption
   * key. i.e. projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{cryptoKey}.
   * See https://cloud.google.com/bigquery/docs/customer-managed-encryption for more information.
   * @return value or {@code null} for none
   */
  public java.lang.String getKmsKeyName() {
    return kmsKeyName;
  }

  /**
   * Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table.
   * The BigQuery Service Account associated with your project requires access to this encryption
   * key. i.e. projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{cryptoKey}.
   * See https://cloud.google.com/bigquery/docs/customer-managed-encryption for more information.
   * @param kmsKeyName kmsKeyName or {@code null} for none
   */
  public DatasetTemplate setKmsKeyName(java.lang.String kmsKeyName) {
    this.kmsKeyName = kmsKeyName;
    return this;
  }

  /**
   * Required. The geographic location where the dataset should reside. See
   * https://cloud.google.com/bigquery/docs/locations for supported locations.
   * @return value or {@code null} for none
   */
  public java.lang.String getLocation() {
    return location;
  }

  /**
   * Required. The geographic location where the dataset should reside. See
   * https://cloud.google.com/bigquery/docs/locations for supported locations.
   * @param location location or {@code null} for none
   */
  public DatasetTemplate setLocation(java.lang.String location) {
    this.location = location;
    return this;
  }

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

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

}