com.google.api.services.spanner.v1.model

Class RestoreDatabaseMetadata

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.spanner.v1.model.RestoreDatabaseMetadata

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class RestoreDatabaseMetadata
extends com.google.api.client.json.GenericJson

Metadata type for the long-running operation returned by 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.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
RestoreDatabaseMetadata()

Method Summary

Modifier and Type	Method and Description
RestoreDatabaseMetadata	clone()
BackupInfo	getBackupInfo() Information about the backup used to restore the database.
String	getCancelTime() The time at which cancellation of this operation was received.
String	getName() Name of the database being created and restored to.
String	getOptimizeDatabaseOperationName() If exists, the name of the long-running operation that will be used to track the post-restore optimization process to optimize the performance of the restored database, and remove the dependency on the restore source.
OperationProgress	getProgress() The progress of the RestoreDatabase operation.
String	getSourceType() The type of the restore source.
RestoreDatabaseMetadata	set(String fieldName, Object value)
RestoreDatabaseMetadata	setBackupInfo(BackupInfo backupInfo) Information about the backup used to restore the database.
RestoreDatabaseMetadata	setCancelTime(String cancelTime) The time at which cancellation of this operation was received.
RestoreDatabaseMetadata	setName(String name) Name of the database being created and restored to.
RestoreDatabaseMetadata	setOptimizeDatabaseOperationName(String optimizeDatabaseOperationName) If exists, the name of the long-running operation that will be used to track the post-restore optimization process to optimize the performance of the restored database, and remove the dependency on the restore source.
RestoreDatabaseMetadata	setProgress(OperationProgress progress) The progress of the RestoreDatabase operation.
RestoreDatabaseMetadata	setSourceType(String sourceType) The type of the restore source.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

RestoreDatabaseMetadata

public RestoreDatabaseMetadata()

Method Detail

getBackupInfo

public BackupInfo getBackupInfo()

Information about the backup used to restore the database.

Returns:

value or null for none

setBackupInfo

public RestoreDatabaseMetadata setBackupInfo(BackupInfo backupInfo)

Information about the backup used to restore the database.

Parameters:

backupInfo - backupInfo or null for none

getCancelTime

public String getCancelTime()

The time at which cancellation of this operation was received. Operations.CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

Returns:

value or null for none

setCancelTime

public RestoreDatabaseMetadata setCancelTime(String cancelTime)

The time at which cancellation of this operation was received. Operations.CancelOperation starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

Parameters:

cancelTime - cancelTime or null for none

getName

public String getName()

Name of the database being created and restored to.

Returns:

value or null for none

setName

public RestoreDatabaseMetadata setName(String name)

Name of the database being created and restored to.

Parameters:

name - name or null for none

getOptimizeDatabaseOperationName

public String getOptimizeDatabaseOperationName()

If exists, the name of the long-running operation that will be used to track the post-restore optimization process to optimize the performance of the restored database, and remove the dependency on the restore source. The name is of the form `projects//instances//databases//operations/` where the is the name of database being created and restored to. The metadata type of the long-running operation is OptimizeRestoredDatabaseMetadata. This long-running operation will be automatically created by the system after the RestoreDatabase long-running operation completes successfully. This operation will not be created if the restore was not successful.

Returns:

value or null for none

setOptimizeDatabaseOperationName

public RestoreDatabaseMetadata setOptimizeDatabaseOperationName(String optimizeDatabaseOperationName)

If exists, the name of the long-running operation that will be used to track the post-restore optimization process to optimize the performance of the restored database, and remove the dependency on the restore source. The name is of the form `projects//instances//databases//operations/` where the is the name of database being created and restored to. The metadata type of the long-running operation is OptimizeRestoredDatabaseMetadata. This long-running operation will be automatically created by the system after the RestoreDatabase long-running operation completes successfully. This operation will not be created if the restore was not successful.

Parameters:

optimizeDatabaseOperationName - optimizeDatabaseOperationName or null for none

getProgress

public OperationProgress getProgress()

The progress of the RestoreDatabase operation.

Returns:

value or null for none

setProgress

public RestoreDatabaseMetadata setProgress(OperationProgress progress)

The progress of the RestoreDatabase operation.

Parameters:

progress - progress or null for none

getSourceType

public String getSourceType()

The type of the restore source.

Returns:

value or null for none

setSourceType

public RestoreDatabaseMetadata setSourceType(String sourceType)

The type of the restore source.

Parameters:

sourceType - sourceType or null for none

set

public RestoreDatabaseMetadata set(String fieldName,
                                   Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public RestoreDatabaseMetadata clone()

Overrides:

clone in class com.google.api.client.json.GenericJson