com.google.api.services.healthcare.v1.model.DateShiftConfig Maven / Gradle / Ivy

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

/**
 * Shift a date forward or backward in time by a random amount which is consistent for a given
 * patient and crypto key combination.
 *
 *  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 Healthcare 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 DateShiftConfig extends com.google.api.client.json.GenericJson {

  /**
   * An AES 128/192/256 bit key. The date shift is computed based on this key and the patient ID. If
   * the patient ID is empty for a DICOM resource, the date shift is computed based on this key and
   * the study instance UID. If `crypto_key` is not set, then `kms_wrapped` is used to calculate the
   * date shift. If neither is set, a default key is generated for each de-identify operation. Must
   * not be set if `kms_wrapped` is set.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String cryptoKey;

  /**
   * KMS wrapped key. If `kms_wrapped` is not set, then `crypto_key` is used to calculate the date
   * shift. If neither is set, a default key is generated for each de-identify operation. Must not
   * be set if `crypto_key` is set.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private KmsWrappedCryptoKey kmsWrapped;

  /**
   * An AES 128/192/256 bit key. The date shift is computed based on this key and the patient ID. If
   * the patient ID is empty for a DICOM resource, the date shift is computed based on this key and
   * the study instance UID. If `crypto_key` is not set, then `kms_wrapped` is used to calculate the
   * date shift. If neither is set, a default key is generated for each de-identify operation. Must
   * not be set if `kms_wrapped` is set.
   * @see #decodeCryptoKey()
   * @return value or {@code null} for none
   */
  public java.lang.String getCryptoKey() {
    return cryptoKey;
  }

  /**
   * An AES 128/192/256 bit key. The date shift is computed based on this key and the patient ID. If
   * the patient ID is empty for a DICOM resource, the date shift is computed based on this key and
   * the study instance UID. If `crypto_key` is not set, then `kms_wrapped` is used to calculate the
   * date shift. If neither is set, a default key is generated for each de-identify operation. Must
   * not be set if `kms_wrapped` is set.
   * @see #getCryptoKey()
   * @return Base64 decoded value or {@code null} for none
   *
   * @since 1.14
   */
  public byte[] decodeCryptoKey() {
    return com.google.api.client.util.Base64.decodeBase64(cryptoKey);
  }

  /**
   * An AES 128/192/256 bit key. The date shift is computed based on this key and the patient ID. If
   * the patient ID is empty for a DICOM resource, the date shift is computed based on this key and
   * the study instance UID. If `crypto_key` is not set, then `kms_wrapped` is used to calculate the
   * date shift. If neither is set, a default key is generated for each de-identify operation. Must
   * not be set if `kms_wrapped` is set.
   * @see #encodeCryptoKey()
   * @param cryptoKey cryptoKey or {@code null} for none
   */
  public DateShiftConfig setCryptoKey(java.lang.String cryptoKey) {
    this.cryptoKey = cryptoKey;
    return this;
  }

  /**
   * An AES 128/192/256 bit key. The date shift is computed based on this key and the patient ID. If
   * the patient ID is empty for a DICOM resource, the date shift is computed based on this key and
   * the study instance UID. If `crypto_key` is not set, then `kms_wrapped` is used to calculate the
   * date shift. If neither is set, a default key is generated for each de-identify operation. Must
   * not be set if `kms_wrapped` is set.
   * @see #setCryptoKey()
   *
   * 
   * The value is encoded Base64 or {@code null} for none.
   * 
   *
   * @since 1.14
   */
  public DateShiftConfig encodeCryptoKey(byte[] cryptoKey) {
    this.cryptoKey = com.google.api.client.util.Base64.encodeBase64URLSafeString(cryptoKey);
    return this;
  }

  /**
   * KMS wrapped key. If `kms_wrapped` is not set, then `crypto_key` is used to calculate the date
   * shift. If neither is set, a default key is generated for each de-identify operation. Must not
   * be set if `crypto_key` is set.
   * @return value or {@code null} for none
   */
  public KmsWrappedCryptoKey getKmsWrapped() {
    return kmsWrapped;
  }

  /**
   * KMS wrapped key. If `kms_wrapped` is not set, then `crypto_key` is used to calculate the date
   * shift. If neither is set, a default key is generated for each de-identify operation. Must not
   * be set if `crypto_key` is set.
   * @param kmsWrapped kmsWrapped or {@code null} for none
   */
  public DateShiftConfig setKmsWrapped(KmsWrappedCryptoKey kmsWrapped) {
    this.kmsWrapped = kmsWrapped;
    return this;
  }

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

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

}