com.google.api.services.dlp.v2beta1.model.GooglePrivacyDlpV2beta1KmsWrappedCryptoKey Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2010 Google Inc.
 *
 * 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/google/apis-client-generator/
 * (build: 2017-11-07 19:12:12 UTC)
 * on 2018-01-18 at 22:50:57 UTC 
 * Modify at your own risk.
 */

package com.google.api.services.dlp.v2beta1.model;

/**
 * Include to use an existing data crypto key wrapped by KMS. Authorization requires the following
 * IAM permissions when sending a request to perform a crypto transformation using a kms-wrapped
 * crypto key: dlp.kms.encrypt
 *
 *  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 DLP 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 GooglePrivacyDlpV2beta1KmsWrappedCryptoKey extends com.google.api.client.json.GenericJson {

  /**
   * The resource name of the KMS CryptoKey to use for unwrapping. [required]
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String cryptoKeyName;

  /**
   * The wrapped data crypto key. [required]
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String wrappedKey;

  /**
   * The resource name of the KMS CryptoKey to use for unwrapping. [required]
   * @return value or {@code null} for none
   */
  public java.lang.String getCryptoKeyName() {
    return cryptoKeyName;
  }

  /**
   * The resource name of the KMS CryptoKey to use for unwrapping. [required]
   * @param cryptoKeyName cryptoKeyName or {@code null} for none
   */
  public GooglePrivacyDlpV2beta1KmsWrappedCryptoKey setCryptoKeyName(java.lang.String cryptoKeyName) {
    this.cryptoKeyName = cryptoKeyName;
    return this;
  }

  /**
   * The wrapped data crypto key. [required]
   * @see #decodeWrappedKey()
   * @return value or {@code null} for none
   */
  public java.lang.String getWrappedKey() {
    return wrappedKey;
  }

  /**
   * The wrapped data crypto key. [required]
   * @see #getWrappedKey()
   * @return Base64 decoded value or {@code null} for none
   *
   * @since 1.14
   */
  public byte[] decodeWrappedKey() {
    return com.google.api.client.util.Base64.decodeBase64(wrappedKey);
  }

  /**
   * The wrapped data crypto key. [required]
   * @see #encodeWrappedKey()
   * @param wrappedKey wrappedKey or {@code null} for none
   */
  public GooglePrivacyDlpV2beta1KmsWrappedCryptoKey setWrappedKey(java.lang.String wrappedKey) {
    this.wrappedKey = wrappedKey;
    return this;
  }

  /**
   * The wrapped data crypto key. [required]
   * @see #setWrappedKey()
   *
   * 
   * The value is encoded Base64 or {@code null} for none.
   * 
   *
   * @since 1.14
   */
  public GooglePrivacyDlpV2beta1KmsWrappedCryptoKey encodeWrappedKey(byte[] wrappedKey) {
    this.wrappedKey = com.google.api.client.util.Base64.encodeBase64URLSafeString(wrappedKey);
    return this;
  }

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

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

}