com.google.api.services.spanner.v1.model.RestoreDatabaseRequest Maven / Gradle / Ivy

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

/**
 * The request for RestoreDatabase.
 *
 *  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 Spanner 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 RestoreDatabaseRequest extends com.google.api.client.json.GenericJson {

  /**
   * Name of the backup from which to restore. Values are of the form
   * `projects//instances//backups/`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String backup;

  /**
   * Required. The id of the database to create and restore to. This database must not already
   * exist. The `database_id` appended to `parent` forms the full database name of the form
   * `projects//instances//databases/`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private java.lang.String databaseId;

  /**
   * Optional. An encryption configuration describing the encryption type and key resources in Cloud
   * KMS used to encrypt/decrypt the database to restore to. If this field is not specified, the
   * restored database will use the same encryption configuration as the backup by default, namely
   * encryption_type = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
   * The value may be {@code null}.
   */
  @com.google.api.client.util.Key
  private RestoreDatabaseEncryptionConfig encryptionConfig;

  /**
   * Name of the backup from which to restore. Values are of the form
   * `projects//instances//backups/`.
   * @return value or {@code null} for none
   */
  public java.lang.String getBackup() {
    return backup;
  }

  /**
   * Name of the backup from which to restore. Values are of the form
   * `projects//instances//backups/`.
   * @param backup backup or {@code null} for none
   */
  public RestoreDatabaseRequest setBackup(java.lang.String backup) {
    this.backup = backup;
    return this;
  }

  /**
   * Required. The id of the database to create and restore to. This database must not already
   * exist. The `database_id` appended to `parent` forms the full database name of the form
   * `projects//instances//databases/`.
   * @return value or {@code null} for none
   */
  public java.lang.String getDatabaseId() {
    return databaseId;
  }

  /**
   * Required. The id of the database to create and restore to. This database must not already
   * exist. The `database_id` appended to `parent` forms the full database name of the form
   * `projects//instances//databases/`.
   * @param databaseId databaseId or {@code null} for none
   */
  public RestoreDatabaseRequest setDatabaseId(java.lang.String databaseId) {
    this.databaseId = databaseId;
    return this;
  }

  /**
   * Optional. An encryption configuration describing the encryption type and key resources in Cloud
   * KMS used to encrypt/decrypt the database to restore to. If this field is not specified, the
   * restored database will use the same encryption configuration as the backup by default, namely
   * encryption_type = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
   * @return value or {@code null} for none
   */
  public RestoreDatabaseEncryptionConfig getEncryptionConfig() {
    return encryptionConfig;
  }

  /**
   * Optional. An encryption configuration describing the encryption type and key resources in Cloud
   * KMS used to encrypt/decrypt the database to restore to. If this field is not specified, the
   * restored database will use the same encryption configuration as the backup by default, namely
   * encryption_type = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`.
   * @param encryptionConfig encryptionConfig or {@code null} for none
   */
  public RestoreDatabaseRequest setEncryptionConfig(RestoreDatabaseEncryptionConfig encryptionConfig) {
    this.encryptionConfig = encryptionConfig;
    return this;
  }

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

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

}