com.google.api.services.bigtableadmin.v2.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-bigtableadmin Show documentation
The 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.bigtableadmin.v2.model;

/**
 * Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster.
 *
 *  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 Bigtable Admin 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 {

  /**
   * Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable
   * cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated
   * with the project that contains this cluster must be granted the
   * `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key. 2) Only regional keys can be used
   * and the region of the CMEK key must match the region of the cluster. Values are of the form
   * `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String kmsKeyName;

  /**
   * Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable
   * cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated
   * with the project that contains this cluster must be granted the
   * `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key. 2) Only regional keys can be used
   * and the region of the CMEK key must match the region of the cluster. Values are of the form
   * `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
   * @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 the destination Bigtable
   * cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated
   * with the project that contains this cluster must be granted the
   * `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key. 2) Only regional keys can be used
   * and the region of the CMEK key must match the region of the cluster. Values are of the form
   * `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
   * @param kmsKeyName kmsKeyName or {@code null} for none
   */
  public EncryptionConfig setKmsKeyName(java.lang.String kmsKeyName) {
    this.kmsKeyName = kmsKeyName;
    return this;
  }

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

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

}