Class CreateBackupMetadata (6.72.0)

public final class CreateBackupMetadata extends GeneratedMessageV3 implements CreateBackupMetadataOrBuilder

Metadata type for the operation returned by CreateBackup.

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

Static Fields

CANCEL_TIME_FIELD_NUMBER

public static final int CANCEL_TIME_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_FIELD_NUMBER

public static final int DATABASE_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

Static Methods

getDefaultInstance()

public static CreateBackupMetadata getDefaultInstance()
Returns
Type Description
CreateBackupMetadata

getDescriptor()

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

newBuilder()

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

newBuilder(CreateBackupMetadata prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

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 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.

.google.protobuf.Timestamp cancel_time = 4;

Returns
Type Description
Timestamp

The cancelTime.

getCancelTimeOrBuilder()

public TimestampOrBuilder getCancelTimeOrBuilder()

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.

.google.protobuf.Timestamp cancel_time = 4;

Returns
Type Description
TimestampOrBuilder

getDatabase()

public String getDatabase()

The name of the database the backup is created from.

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

Returns
Type Description
String

The database.

getDatabaseBytes()

public ByteString getDatabaseBytes()

The name of the database the backup is created from.

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

Returns
Type Description
ByteString

The bytes for database.

getDefaultInstanceForType()

public CreateBackupMetadata getDefaultInstanceForType()
Returns
Type Description
CreateBackupMetadata

getName()

public String getName()

The name of the backup being created.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of the backup being created.

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getProgress()

public OperationProgress getProgress()

The progress of the CreateBackup operation.

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

Returns
Type Description
OperationProgress

The progress.

getProgressOrBuilder()

public OperationProgressOrBuilder getProgressOrBuilder()

The progress of the CreateBackup operation.

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

Returns
Type Description
OperationProgressOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCancelTime()

public boolean hasCancelTime()

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.

.google.protobuf.Timestamp cancel_time = 4;

Returns
Type Description
boolean

Whether the cancelTime field is set.

hasProgress()

public boolean hasProgress()

The progress of the CreateBackup 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 CreateBackupMetadata.Builder newBuilderForType()
Returns
Type Description
CreateBackupMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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