com.google.api.services.secretmanager.v1.model.CustomerManagedEncryption Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-api-services-secretmanager 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.secretmanager.v1.model;

/**
 * Configuration for encrypting secret payloads using customer-managed encryption keys (CMEK).
 *
 *  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 Secret Manager 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 CustomerManagedEncryption extends com.google.api.client.json.GenericJson {

  /**
   * Required. The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads. For
   * secrets using the UserManaged replication policy type, Cloud KMS CryptoKeys must reside in the
   * same location as the replica location. For secrets using the Automatic replication policy type,
   * Cloud KMS CryptoKeys must reside in `global`. The expected format is
   * `projects/locations/keyRings/cryptoKeys`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String kmsKeyName;

  /**
   * Required. The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads. For
   * secrets using the UserManaged replication policy type, Cloud KMS CryptoKeys must reside in the
   * same location as the replica location. For secrets using the Automatic replication policy type,
   * Cloud KMS CryptoKeys must reside in `global`. The expected format is
   * `projects/locations/keyRings/cryptoKeys`.
   * @return value or {@code null} for none
   */
  public java.lang.String getKmsKeyName() {
    return kmsKeyName;
  }

  /**
   * Required. The resource name of the Cloud KMS CryptoKey used to encrypt secret payloads. For
   * secrets using the UserManaged replication policy type, Cloud KMS CryptoKeys must reside in the
   * same location as the replica location. For secrets using the Automatic replication policy type,
   * Cloud KMS CryptoKeys must reside in `global`. The expected format is
   * `projects/locations/keyRings/cryptoKeys`.
   * @param kmsKeyName kmsKeyName or {@code null} for none
   */
  public CustomerManagedEncryption setKmsKeyName(java.lang.String kmsKeyName) {
    this.kmsKeyName = kmsKeyName;
    return this;
  }

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

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

}