com.google.api.services.privateca.v1.model.KeyVersionSpec 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.privateca.v1.model;

/**
 * A Cloud KMS key configuration that a CertificateAuthority will use.
 *
 *  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 Certificate Authority 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 KeyVersionSpec extends com.google.api.client.json.GenericJson {

  /**
   * The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience.
   * All managed keys will be have their ProtectionLevel as `HSM`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String algorithm;

  /**
   * The resource name for an existing Cloud KMS CryptoKeyVersion in the format
   * `projects/locations/keyRings/cryptoKeys/cryptoKeyVersions`. This option enables full
   * flexibility in the key's capabilities and properties.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String cloudKmsKeyVersion;

  /**
   * The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience.
   * All managed keys will be have their ProtectionLevel as `HSM`.
   * @return value or {@code null} for none
   */
  public java.lang.String getAlgorithm() {
    return algorithm;
  }

  /**
   * The algorithm to use for creating a managed Cloud KMS key for a for a simplified experience.
   * All managed keys will be have their ProtectionLevel as `HSM`.
   * @param algorithm algorithm or {@code null} for none
   */
  public KeyVersionSpec setAlgorithm(java.lang.String algorithm) {
    this.algorithm = algorithm;
    return this;
  }

  /**
   * The resource name for an existing Cloud KMS CryptoKeyVersion in the format
   * `projects/locations/keyRings/cryptoKeys/cryptoKeyVersions`. This option enables full
   * flexibility in the key's capabilities and properties.
   * @return value or {@code null} for none
   */
  public java.lang.String getCloudKmsKeyVersion() {
    return cloudKmsKeyVersion;
  }

  /**
   * The resource name for an existing Cloud KMS CryptoKeyVersion in the format
   * `projects/locations/keyRings/cryptoKeys/cryptoKeyVersions`. This option enables full
   * flexibility in the key's capabilities and properties.
   * @param cloudKmsKeyVersion cloudKmsKeyVersion or {@code null} for none
   */
  public KeyVersionSpec setCloudKmsKeyVersion(java.lang.String cloudKmsKeyVersion) {
    this.cloudKmsKeyVersion = cloudKmsKeyVersion;
    return this;
  }

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

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

}