Class RestoreDatabaseMetadata
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessageV3
-
- com.google.spanner.admin.database.v1.RestoreDatabaseMetadata
-
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,RestoreDatabaseMetadataOrBuilder
,Serializable
public final class RestoreDatabaseMetadata extends com.google.protobuf.GeneratedMessageV3 implements RestoreDatabaseMetadataOrBuilder
Metadata type for the long-running operation returned by [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase].
Protobuf typegoogle.spanner.admin.database.v1.RestoreDatabaseMetadata
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RestoreDatabaseMetadata.Builder
Metadata type for the long-running operation returned by [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase].static class
RestoreDatabaseMetadata.SourceInfoCase
-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description static int
BACKUP_INFO_FIELD_NUMBER
static int
CANCEL_TIME_FIELD_NUMBER
static int
NAME_FIELD_NUMBER
static int
OPTIMIZE_DATABASE_OPERATION_NAME_FIELD_NUMBER
static int
PROGRESS_FIELD_NUMBER
static int
SOURCE_TYPE_FIELD_NUMBER
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object obj)
BackupInfo
getBackupInfo()
Information about the backup used to restore the database.BackupInfoOrBuilder
getBackupInfoOrBuilder()
Information about the backup used to restore the database.com.google.protobuf.Timestamp
getCancelTime()
The time at which cancellation of this operation was received.com.google.protobuf.TimestampOrBuilder
getCancelTimeOrBuilder()
The time at which cancellation of this operation was received.static RestoreDatabaseMetadata
getDefaultInstance()
RestoreDatabaseMetadata
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
String
getName()
Name of the database being created and restored to.com.google.protobuf.ByteString
getNameBytes()
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.com.google.protobuf.ByteString
getOptimizeDatabaseOperationNameBytes()
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.com.google.protobuf.Parser<RestoreDatabaseMetadata>
getParserForType()
OperationProgress
getProgress()
The progress of the [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase] operation.OperationProgressOrBuilder
getProgressOrBuilder()
The progress of the [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase] operation.int
getSerializedSize()
RestoreDatabaseMetadata.SourceInfoCase
getSourceInfoCase()
RestoreSourceType
getSourceType()
The type of the restore source.int
getSourceTypeValue()
The type of the restore source.com.google.protobuf.UnknownFieldSet
getUnknownFields()
boolean
hasBackupInfo()
Information about the backup used to restore the database.boolean
hasCancelTime()
The time at which cancellation of this operation was received.int
hashCode()
boolean
hasProgress()
The progress of the [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase] operation.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static RestoreDatabaseMetadata.Builder
newBuilder()
static RestoreDatabaseMetadata.Builder
newBuilder(RestoreDatabaseMetadata prototype)
RestoreDatabaseMetadata.Builder
newBuilderForType()
protected RestoreDatabaseMetadata.Builder
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RestoreDatabaseMetadata
parseDelimitedFrom(InputStream input)
static RestoreDatabaseMetadata
parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RestoreDatabaseMetadata
parseFrom(byte[] data)
static RestoreDatabaseMetadata
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RestoreDatabaseMetadata
parseFrom(com.google.protobuf.ByteString data)
static RestoreDatabaseMetadata
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RestoreDatabaseMetadata
parseFrom(com.google.protobuf.CodedInputStream input)
static RestoreDatabaseMetadata
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RestoreDatabaseMetadata
parseFrom(InputStream input)
static RestoreDatabaseMetadata
parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RestoreDatabaseMetadata
parseFrom(ByteBuffer data)
static RestoreDatabaseMetadata
parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RestoreDatabaseMetadata>
parser()
RestoreDatabaseMetadata.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
SOURCE_TYPE_FIELD_NUMBER
public static final int SOURCE_TYPE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
BACKUP_INFO_FIELD_NUMBER
public static final int BACKUP_INFO_FIELD_NUMBER
- See Also:
- Constant Field Values
-
PROGRESS_FIELD_NUMBER
public static final int PROGRESS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
CANCEL_TIME_FIELD_NUMBER
public static final int CANCEL_TIME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
OPTIMIZE_DATABASE_OPERATION_NAME_FIELD_NUMBER
public static final int OPTIMIZE_DATABASE_OPERATION_NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
-
Method Detail
-
newInstance
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
- Specified by:
getUnknownFields
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getUnknownFields
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getSourceInfoCase
public RestoreDatabaseMetadata.SourceInfoCase getSourceInfoCase()
- Specified by:
getSourceInfoCase
in interfaceRestoreDatabaseMetadataOrBuilder
-
getName
public String getName()
Name of the database being created and restored to.
string name = 1 [(.google.api.resource_reference) = { ... }
- Specified by:
getName
in interfaceRestoreDatabaseMetadataOrBuilder
- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()
Name of the database being created and restored to.
string name = 1 [(.google.api.resource_reference) = { ... }
- Specified by:
getNameBytes
in interfaceRestoreDatabaseMetadataOrBuilder
- Returns:
- The bytes for name.
-
getSourceTypeValue
public int getSourceTypeValue()
The type of the restore source.
.google.spanner.admin.database.v1.RestoreSourceType source_type = 2;
- Specified by:
getSourceTypeValue
in interfaceRestoreDatabaseMetadataOrBuilder
- Returns:
- The enum numeric value on the wire for sourceType.
-
getSourceType
public RestoreSourceType getSourceType()
The type of the restore source.
.google.spanner.admin.database.v1.RestoreSourceType source_type = 2;
- Specified by:
getSourceType
in interfaceRestoreDatabaseMetadataOrBuilder
- Returns:
- The sourceType.
-
hasBackupInfo
public boolean hasBackupInfo()
Information about the backup used to restore the database.
.google.spanner.admin.database.v1.BackupInfo backup_info = 3;
- Specified by:
hasBackupInfo
in interfaceRestoreDatabaseMetadataOrBuilder
- Returns:
- Whether the backupInfo field is set.
-
getBackupInfo
public BackupInfo getBackupInfo()
Information about the backup used to restore the database.
.google.spanner.admin.database.v1.BackupInfo backup_info = 3;
- Specified by:
getBackupInfo
in interfaceRestoreDatabaseMetadataOrBuilder
- Returns:
- The backupInfo.
-
getBackupInfoOrBuilder
public BackupInfoOrBuilder getBackupInfoOrBuilder()
Information about the backup used to restore the database.
.google.spanner.admin.database.v1.BackupInfo backup_info = 3;
- Specified by:
getBackupInfoOrBuilder
in interfaceRestoreDatabaseMetadataOrBuilder
-
hasProgress
public boolean hasProgress()
The progress of the [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase] operation.
.google.spanner.admin.database.v1.OperationProgress progress = 4;
- Specified by:
hasProgress
in interfaceRestoreDatabaseMetadataOrBuilder
- Returns:
- Whether the progress field is set.
-
getProgress
public OperationProgress getProgress()
The progress of the [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase] operation.
.google.spanner.admin.database.v1.OperationProgress progress = 4;
- Specified by:
getProgress
in interfaceRestoreDatabaseMetadataOrBuilder
- Returns:
- The progress.
-
getProgressOrBuilder
public OperationProgressOrBuilder getProgressOrBuilder()
The progress of the [RestoreDatabase][google.spanner.admin.database.v1.DatabaseAdmin.RestoreDatabase] operation.
.google.spanner.admin.database.v1.OperationProgress progress = 4;
- Specified by:
getProgressOrBuilder
in interfaceRestoreDatabaseMetadataOrBuilder
-
hasCancelTime
public boolean hasCancelTime()
The time at which cancellation of this operation was received. [Operations.CancelOperation][google.longrunning.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][google.longrunning.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][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.
.google.protobuf.Timestamp cancel_time = 5;
- Specified by:
hasCancelTime
in interfaceRestoreDatabaseMetadataOrBuilder
- Returns:
- Whether the cancelTime field is set.
-
getCancelTime
public com.google.protobuf.Timestamp getCancelTime()
The time at which cancellation of this operation was received. [Operations.CancelOperation][google.longrunning.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][google.longrunning.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][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.
.google.protobuf.Timestamp cancel_time = 5;
- Specified by:
getCancelTime
in interfaceRestoreDatabaseMetadataOrBuilder
- Returns:
- The cancelTime.
-
getCancelTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getCancelTimeOrBuilder()
The time at which cancellation of this operation was received. [Operations.CancelOperation][google.longrunning.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][google.longrunning.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][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.
.google.protobuf.Timestamp cancel_time = 5;
- Specified by:
getCancelTimeOrBuilder
in interfaceRestoreDatabaseMetadataOrBuilder
-
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/<project>/instances/<instance>/databases/<database>/operations/<operation>` where the <database> is the name of database being created and restored to. The metadata type of the long-running operation is [OptimizeRestoredDatabaseMetadata][google.spanner.admin.database.v1.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.
string optimize_database_operation_name = 6;
- Specified by:
getOptimizeDatabaseOperationName
in interfaceRestoreDatabaseMetadataOrBuilder
- Returns:
- The optimizeDatabaseOperationName.
-
getOptimizeDatabaseOperationNameBytes
public com.google.protobuf.ByteString getOptimizeDatabaseOperationNameBytes()
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/<project>/instances/<instance>/databases/<database>/operations/<operation>` where the <database> is the name of database being created and restored to. The metadata type of the long-running operation is [OptimizeRestoredDatabaseMetadata][google.spanner.admin.database.v1.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.
string optimize_database_operation_name = 6;
- Specified by:
getOptimizeDatabaseOperationNameBytes
in interfaceRestoreDatabaseMetadataOrBuilder
- Returns:
- The bytes for optimizeDatabaseOperationName.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
public boolean equals(Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static RestoreDatabaseMetadata parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RestoreDatabaseMetadata parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RestoreDatabaseMetadata parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RestoreDatabaseMetadata parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RestoreDatabaseMetadata parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RestoreDatabaseMetadata parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RestoreDatabaseMetadata parseFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static RestoreDatabaseMetadata parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static RestoreDatabaseMetadata parseDelimitedFrom(InputStream input) throws IOException
- Throws:
IOException
-
parseDelimitedFrom
public static RestoreDatabaseMetadata parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
parseFrom
public static RestoreDatabaseMetadata parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
- Throws:
IOException
-
parseFrom
public static RestoreDatabaseMetadata parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Throws:
IOException
-
newBuilderForType
public RestoreDatabaseMetadata.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static RestoreDatabaseMetadata.Builder newBuilder()
-
newBuilder
public static RestoreDatabaseMetadata.Builder newBuilder(RestoreDatabaseMetadata prototype)
-
toBuilder
public RestoreDatabaseMetadata.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected RestoreDatabaseMetadata.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
- Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
public static RestoreDatabaseMetadata getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<RestoreDatabaseMetadata> parser()
-
getParserForType
public com.google.protobuf.Parser<RestoreDatabaseMetadata> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
public RestoreDatabaseMetadata getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-