<?php
/*
 * Copyright 2014 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.
 */

namespace Google\Service\Spanner;

class CopyBackupEncryptionConfig extends \Google\Collection
{
  /**
   * Unspecified. Do not use.
   */
  public const ENCRYPTION_TYPE_ENCRYPTION_TYPE_UNSPECIFIED = 'ENCRYPTION_TYPE_UNSPECIFIED';
  /**
   * This is the default option for CopyBackup when encryption_config is not
   * specified. For example, if the source backup is using
   * `Customer_Managed_Encryption`, the backup will be using the same Cloud KMS
   * key as the source backup.
   */
  public const ENCRYPTION_TYPE_USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION = 'USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION';
  /**
   * Use Google default encryption.
   */
  public const ENCRYPTION_TYPE_GOOGLE_DEFAULT_ENCRYPTION = 'GOOGLE_DEFAULT_ENCRYPTION';
  /**
   * Use customer managed encryption. If specified, either `kms_key_name` or
   * `kms_key_names` must contain valid Cloud KMS keys.
   */
  public const ENCRYPTION_TYPE_CUSTOMER_MANAGED_ENCRYPTION = 'CUSTOMER_MANAGED_ENCRYPTION';
  protected $collection_key = 'kmsKeyNames';
  /**
   * Required. The encryption type of the backup.
   *
   * @var string
   */
  public $encryptionType;
  /**
   * Optional. This field is maintained for backwards compatibility. For new
   * callers, we recommend using `kms_key_names` to specify the KMS key. Only
   * use `kms_key_name` if the location of the KMS key matches the database
   * instance's configuration (location) exactly. For example, if the KMS
   * location is in `us-central1` or `nam3`, then the database instance must
   * also be in `us-central1` or `nam3`. The Cloud KMS key that is used to
   * encrypt and decrypt the restored database. Set this field only when
   * encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form
   * `projects//locations//keyRings//cryptoKeys/`.
   *
   * @var string
   */
  public $kmsKeyName;
  /**
   * Optional. Specifies the KMS configuration for the one or more keys used to
   * protect the backup. Values are of the form
   * `projects//locations//keyRings//cryptoKeys/`. KMS keys specified can be in
   * any order. The keys referenced by `kms_key_names` must fully cover all
   * regions of the backup's instance configuration. Some examples: * For
   * regional (single-region) instance configurations, specify a regional
   * location KMS key. * For multi-region instance configurations of type
   * `GOOGLE_MANAGED`, either specify a multi-region location KMS key or
   * multiple regional location KMS keys that cover all regions in the instance
   * configuration. * For an instance configuration of type `USER_MANAGED`,
   * specify only regional location KMS keys to cover each region in the
   * instance configuration. Multi-region location KMS keys aren't supported for
   * `USER_MANAGED` type instance configurations.
   *
   * @var string[]
   */
  public $kmsKeyNames;

  /**
   * Required. The encryption type of the backup.
   *
   * Accepted values: ENCRYPTION_TYPE_UNSPECIFIED,
   * USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION, GOOGLE_DEFAULT_ENCRYPTION,
   * CUSTOMER_MANAGED_ENCRYPTION
   *
   * @param self::ENCRYPTION_TYPE_* $encryptionType
   */
  public function setEncryptionType($encryptionType)
  {
    $this->encryptionType = $encryptionType;
  }
  /**
   * @return self::ENCRYPTION_TYPE_*
   */
  public function getEncryptionType()
  {
    return $this->encryptionType;
  }
  /**
   * Optional. This field is maintained for backwards compatibility. For new
   * callers, we recommend using `kms_key_names` to specify the KMS key. Only
   * use `kms_key_name` if the location of the KMS key matches the database
   * instance's configuration (location) exactly. For example, if the KMS
   * location is in `us-central1` or `nam3`, then the database instance must
   * also be in `us-central1` or `nam3`. The Cloud KMS key that is used to
   * encrypt and decrypt the restored database. Set this field only when
   * encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form
   * `projects//locations//keyRings//cryptoKeys/`.
   *
   * @param string $kmsKeyName
   */
  public function setKmsKeyName($kmsKeyName)
  {
    $this->kmsKeyName = $kmsKeyName;
  }
  /**
   * @return string
   */
  public function getKmsKeyName()
  {
    return $this->kmsKeyName;
  }
  /**
   * Optional. Specifies the KMS configuration for the one or more keys used to
   * protect the backup. Values are of the form
   * `projects//locations//keyRings//cryptoKeys/`. KMS keys specified can be in
   * any order. The keys referenced by `kms_key_names` must fully cover all
   * regions of the backup's instance configuration. Some examples: * For
   * regional (single-region) instance configurations, specify a regional
   * location KMS key. * For multi-region instance configurations of type
   * `GOOGLE_MANAGED`, either specify a multi-region location KMS key or
   * multiple regional location KMS keys that cover all regions in the instance
   * configuration. * For an instance configuration of type `USER_MANAGED`,
   * specify only regional location KMS keys to cover each region in the
   * instance configuration. Multi-region location KMS keys aren't supported for
   * `USER_MANAGED` type instance configurations.
   *
   * @param string[] $kmsKeyNames
   */
  public function setKmsKeyNames($kmsKeyNames)
  {
    $this->kmsKeyNames = $kmsKeyNames;
  }
  /**
   * @return string[]
   */
  public function getKmsKeyNames()
  {
    return $this->kmsKeyNames;
  }
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CopyBackupEncryptionConfig::class, 'Google_Service_Spanner_CopyBackupEncryptionConfig');