Class CopyBackupMetadata (6.65.1)

public final class CopyBackupMetadata extends GeneratedMessageV3 implements CopyBackupMetadataOrBuilder

Metadata type for the google.longrunning.Operation returned by CopyBackup.

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

Static Fields

CANCEL_TIME_FIELD_NUMBER

public static final int CANCEL_TIME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PROGRESS_FIELD_NUMBER

public static final int PROGRESS_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_BACKUP_FIELD_NUMBER

public static final int SOURCE_BACKUP_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CopyBackupMetadata getDefaultInstance()
Returns
Type Description
CopyBackupMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CopyBackupMetadata.Builder newBuilder()
Returns
Type Description
CopyBackupMetadata.Builder

newBuilder(CopyBackupMetadata prototype)

public static CopyBackupMetadata.Builder newBuilder(CopyBackupMetadata prototype)
Parameter
Name Description
prototype CopyBackupMetadata
Returns
Type Description
CopyBackupMetadata.Builder

parseDelimitedFrom(InputStream input)

public static CopyBackupMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CopyBackupMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CopyBackupMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CopyBackupMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CopyBackupMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CopyBackupMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CopyBackupMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CopyBackupMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CopyBackupMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CopyBackupMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CopyBackupMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CopyBackupMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CopyBackupMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CopyBackupMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CopyBackupMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CopyBackupMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CopyBackupMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CopyBackupMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CopyBackupMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CopyBackupMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CopyBackupMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CopyBackupMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CopyBackupMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CopyBackupMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CopyBackupMetadata> parser()
Returns
Type Description
Parser<CopyBackupMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCancelTime()

public Timestamp getCancelTime()

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
Type Description
Timestamp

The cancelTime.

getCancelTimeOrBuilder()

public TimestampOrBuilder getCancelTimeOrBuilder()

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
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public CopyBackupMetadata getDefaultInstanceForType()
Returns
Type Description
CopyBackupMetadata

getName()

public String getName()

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
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<CopyBackupMetadata> getParserForType()
Returns
Type Description
Parser<CopyBackupMetadata>
Overrides

getProgress()

public OperationProgress getProgress()

The progress of the CopyBackup operation.

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

Returns
Type Description
OperationProgress

The progress.

getProgressOrBuilder()

public OperationProgressOrBuilder getProgressOrBuilder()

The progress of the CopyBackup operation.

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

Returns
Type Description
OperationProgressOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceBackup()

public String getSourceBackup()

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
Type Description
String

The sourceBackup.

getSourceBackupBytes()

public ByteString getSourceBackupBytes()

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
Type Description
ByteString

The bytes for sourceBackup.

hasCancelTime()

public boolean hasCancelTime()

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
Type Description
boolean

Whether the cancelTime field is set.

hasProgress()

public boolean hasProgress()

The progress of the CopyBackup operation.

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

Returns
Type Description
boolean

Whether the progress field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CopyBackupMetadata.Builder newBuilderForType()
Returns
Type Description
CopyBackupMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CopyBackupMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CopyBackupMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CopyBackupMetadata.Builder toBuilder()
Returns
Type Description
CopyBackupMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException