Class CopyBackupMetadata (6.89.0)

publicfinalclassCopyBackupMetadataextendsGeneratedMessageV3implementsCopyBackupMetadataOrBuilder

Metadata type for the operation returned by CopyBackup.

Protobuf type google.spanner.admin.database.v1.CopyBackupMetadata

Static Fields

CANCEL_TIME_FIELD_NUMBER

publicstaticfinalintCANCEL_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

publicstaticfinalintNAME_FIELD_NUMBER
Field Value
TypeDescription
int

PROGRESS_FIELD_NUMBER

publicstaticfinalintPROGRESS_FIELD_NUMBER
Field Value
TypeDescription
int

SOURCE_BACKUP_FIELD_NUMBER

publicstaticfinalintSOURCE_BACKUP_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

publicstaticCopyBackupMetadatagetDefaultInstance()
Returns
TypeDescription
CopyBackupMetadata

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

publicstaticCopyBackupMetadata.BuildernewBuilder()
Returns
TypeDescription
CopyBackupMetadata.Builder

newBuilder(CopyBackupMetadata prototype)

publicstaticCopyBackupMetadata.BuildernewBuilder(CopyBackupMetadataprototype)
Parameter
NameDescription
prototypeCopyBackupMetadata
Returns
TypeDescription
CopyBackupMetadata.Builder

parseDelimitedFrom(InputStream input)

publicstaticCopyBackupMetadataparseDelimitedFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CopyBackupMetadata
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticCopyBackupMetadataparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CopyBackupMetadata
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

publicstaticCopyBackupMetadataparseFrom(byte[]data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CopyBackupMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticCopyBackupMetadataparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CopyBackupMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticCopyBackupMetadataparseFrom(ByteStringdata)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CopyBackupMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticCopyBackupMetadataparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CopyBackupMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticCopyBackupMetadataparseFrom(CodedInputStreaminput)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CopyBackupMetadata
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticCopyBackupMetadataparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CopyBackupMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

publicstaticCopyBackupMetadataparseFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CopyBackupMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticCopyBackupMetadataparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CopyBackupMetadata
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

publicstaticCopyBackupMetadataparseFrom(ByteBufferdata)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CopyBackupMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticCopyBackupMetadataparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CopyBackupMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

publicstaticParser<CopyBackupMetadata>parser()
Returns
TypeDescription
Parser<CopyBackupMetadata>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCancelTime()

publicTimestampgetCancelTime()

The time at which cancellation of CopyBackup 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.

.google.protobuf.Timestamp cancel_time = 4;

Returns
TypeDescription
Timestamp

The cancelTime.

getCancelTimeOrBuilder()

publicTimestampOrBuildergetCancelTimeOrBuilder()

The time at which cancellation of CopyBackup 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.

.google.protobuf.Timestamp cancel_time = 4;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

publicCopyBackupMetadatagetDefaultInstanceForType()
Returns
TypeDescription
CopyBackupMetadata

getName()

publicStringgetName()

The name of the backup being created through the copy operation. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

string name = 1 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The name.

getNameBytes()

publicByteStringgetNameBytes()

The name of the backup being created through the copy operation. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

string name = 1 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

publicParser<CopyBackupMetadata>getParserForType()
Returns
TypeDescription
Parser<CopyBackupMetadata>
Overrides

getProgress()

publicOperationProgressgetProgress()

The progress of the CopyBackup operation.

.google.spanner.admin.database.v1.OperationProgress progress = 3;

Returns
TypeDescription
OperationProgress

The progress.

getProgressOrBuilder()

publicOperationProgressOrBuildergetProgressOrBuilder()

The progress of the CopyBackup operation.

.google.spanner.admin.database.v1.OperationProgress progress = 3;

Returns
TypeDescription
OperationProgressOrBuilder

getSerializedSize()

publicintgetSerializedSize()
Returns
TypeDescription
int
Overrides

getSourceBackup()

publicStringgetSourceBackup()

The name of the source backup that is being copied. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

string source_backup = 2 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The sourceBackup.

getSourceBackupBytes()

publicByteStringgetSourceBackupBytes()

The name of the source backup that is being copied. Values are of the form projects/<project>/instances/<instance>/backups/<backup>.

string source_backup = 2 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for sourceBackup.

hasCancelTime()

publicbooleanhasCancelTime()

The time at which cancellation of CopyBackup 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.

.google.protobuf.Timestamp cancel_time = 4;

Returns
TypeDescription
boolean

Whether the cancelTime field is set.

hasProgress()

publicbooleanhasProgress()

The progress of the CopyBackup operation.

.google.spanner.admin.database.v1.OperationProgress progress = 3;

Returns
TypeDescription
boolean

Whether the progress field is set.

hashCode()

publicinthashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

publicCopyBackupMetadata.BuildernewBuilderForType()
Returns
TypeDescription
CopyBackupMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedCopyBackupMetadata.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CopyBackupMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

publicCopyBackupMetadata.BuildertoBuilder()
Returns
TypeDescription
CopyBackupMetadata.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException