com.google.api.services.spanner.v1.model.EncryptionConfig Maven / Gradle / Ivy

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

/**
 * Encryption configuration for a Cloud Spanner database.
 *
 *  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 Spanner 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 EncryptionConfig extends com.google.api.client.json.GenericJson {

  /**
   * The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form
   * `projects//locations//keyRings//cryptoKeys/`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String kmsKeyName;

  /**
   * Specifies the KMS configuration for the one or more keys used to encrypt the database. Values
   * are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by
   * kms_key_names must fully cover all regions of the database instance configuration. Some
   * examples: * For single region database instance configs, specify a single regional location KMS
   * key. * For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a
   * multi-regional location KMS key or multiple regional location KMS keys that cover all regions
   * in the instance config. * For a database instance config of type USER_MANAGED, please specify
   * only regional location KMS keys to cover each region in the instance config. Multi-regional
   * location KMS keys are not supported for USER_MANAGED instance configs.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.util.List kmsKeyNames;

  /**
   * The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form
   * `projects//locations//keyRings//cryptoKeys/`.
   * @return value or {@code null} for none
   */
  public java.lang.String getKmsKeyName() {
    return kmsKeyName;
  }

  /**
   * The Cloud KMS key to be used for encrypting and decrypting the database. Values are of the form
   * `projects//locations//keyRings//cryptoKeys/`.
   * @param kmsKeyName kmsKeyName or {@code null} for none
   */
  public EncryptionConfig setKmsKeyName(java.lang.String kmsKeyName) {
    this.kmsKeyName = kmsKeyName;
    return this;
  }

  /**
   * Specifies the KMS configuration for the one or more keys used to encrypt the database. Values
   * are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by
   * kms_key_names must fully cover all regions of the database instance configuration. Some
   * examples: * For single region database instance configs, specify a single regional location KMS
   * key. * For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a
   * multi-regional location KMS key or multiple regional location KMS keys that cover all regions
   * in the instance config. * For a database instance config of type USER_MANAGED, please specify
   * only regional location KMS keys to cover each region in the instance config. Multi-regional
   * location KMS keys are not supported for USER_MANAGED instance configs.
   * @return value or {@code null} for none
   */
  public java.util.List getKmsKeyNames() {
    return kmsKeyNames;
  }

  /**
   * Specifies the KMS configuration for the one or more keys used to encrypt the database. Values
   * are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by
   * kms_key_names must fully cover all regions of the database instance configuration. Some
   * examples: * For single region database instance configs, specify a single regional location KMS
   * key. * For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a
   * multi-regional location KMS key or multiple regional location KMS keys that cover all regions
   * in the instance config. * For a database instance config of type USER_MANAGED, please specify
   * only regional location KMS keys to cover each region in the instance config. Multi-regional
   * location KMS keys are not supported for USER_MANAGED instance configs.
   * @param kmsKeyNames kmsKeyNames or {@code null} for none
   */
  public EncryptionConfig setKmsKeyNames(java.util.List kmsKeyNames) {
    this.kmsKeyNames = kmsKeyNames;
    return this;
  }

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

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

}