Class RestoreDatabaseMetadata (3.20.0)

public final class RestoreDatabaseMetadata extends GeneratedMessageV3 implements RestoreDatabaseMetadataOrBuilder

Metadata for the long-running operation from the RestoreDatabase request.

Protobuf type google.firestore.admin.v1.RestoreDatabaseMetadata

Static Fields

BACKUP_FIELD_NUMBER

public static final int BACKUP_FIELD_NUMBER
Field Value
TypeDescription
int

DATABASE_FIELD_NUMBER

public static final int DATABASE_FIELD_NUMBER
Field Value
TypeDescription
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

OPERATION_STATE_FIELD_NUMBER

public static final int OPERATION_STATE_FIELD_NUMBER
Field Value
TypeDescription
int

PROGRESS_PERCENTAGE_FIELD_NUMBER

public static final int PROGRESS_PERCENTAGE_FIELD_NUMBER
Field Value
TypeDescription
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RestoreDatabaseMetadata getDefaultInstance()
Returns
TypeDescription
RestoreDatabaseMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static RestoreDatabaseMetadata.Builder newBuilder()
Returns
TypeDescription
RestoreDatabaseMetadata.Builder

newBuilder(RestoreDatabaseMetadata prototype)

public static RestoreDatabaseMetadata.Builder newBuilder(RestoreDatabaseMetadata prototype)
Parameter
NameDescription
prototypeRestoreDatabaseMetadata
Returns
TypeDescription
RestoreDatabaseMetadata.Builder

parseDelimitedFrom(InputStream input)

public static RestoreDatabaseMetadata parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RestoreDatabaseMetadata parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RestoreDatabaseMetadata parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RestoreDatabaseMetadata parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RestoreDatabaseMetadata parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RestoreDatabaseMetadata parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RestoreDatabaseMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RestoreDatabaseMetadata> parser()
Returns
TypeDescription
Parser<RestoreDatabaseMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBackup()

public String getBackup()

The name of the backup restoring from.

string backup = 5 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The backup.

getBackupBytes()

public ByteString getBackupBytes()

The name of the backup restoring from.

string backup = 5 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for backup.

getDatabase()

public String getDatabase()

The name of the database being restored to.

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

Returns
TypeDescription
String

The database.

getDatabaseBytes()

public ByteString getDatabaseBytes()

The name of the database being restored to.

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

Returns
TypeDescription
ByteString

The bytes for database.

getDefaultInstanceForType()

public RestoreDatabaseMetadata getDefaultInstanceForType()
Returns
TypeDescription
RestoreDatabaseMetadata

getEndTime()

public Timestamp getEndTime()

The time the restore finished, unset for ongoing restores.

.google.protobuf.Timestamp end_time = 2;

Returns
TypeDescription
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

The time the restore finished, unset for ongoing restores.

.google.protobuf.Timestamp end_time = 2;

Returns
TypeDescription
TimestampOrBuilder

getOperationState()

public OperationState getOperationState()

The operation state of the restore.

.google.firestore.admin.v1.OperationState operation_state = 3;

Returns
TypeDescription
OperationState

The operationState.

getOperationStateValue()

public int getOperationStateValue()

The operation state of the restore.

.google.firestore.admin.v1.OperationState operation_state = 3;

Returns
TypeDescription
int

The enum numeric value on the wire for operationState.

getParserForType()

public Parser<RestoreDatabaseMetadata> getParserForType()
Returns
TypeDescription
Parser<RestoreDatabaseMetadata>
Overrides

getProgressPercentage()

public Progress getProgressPercentage()

How far along the restore is as an estimated percentage of remaining time.

.google.firestore.admin.v1.Progress progress_percentage = 8;

Returns
TypeDescription
Progress

The progressPercentage.

getProgressPercentageOrBuilder()

public ProgressOrBuilder getProgressPercentageOrBuilder()

How far along the restore is as an estimated percentage of remaining time.

.google.firestore.admin.v1.Progress progress_percentage = 8;

Returns
TypeDescription
ProgressOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStartTime()

public Timestamp getStartTime()

The time the restore was started.

.google.protobuf.Timestamp start_time = 1;

Returns
TypeDescription
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

The time the restore was started.

.google.protobuf.Timestamp start_time = 1;

Returns
TypeDescription
TimestampOrBuilder

hasEndTime()

public boolean hasEndTime()

The time the restore finished, unset for ongoing restores.

.google.protobuf.Timestamp end_time = 2;

Returns
TypeDescription
boolean

Whether the endTime field is set.

hasProgressPercentage()

public boolean hasProgressPercentage()

How far along the restore is as an estimated percentage of remaining time.

.google.firestore.admin.v1.Progress progress_percentage = 8;

Returns
TypeDescription
boolean

Whether the progressPercentage field is set.

hasStartTime()

public boolean hasStartTime()

The time the restore was started.

.google.protobuf.Timestamp start_time = 1;

Returns
TypeDescription
boolean

Whether the startTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public RestoreDatabaseMetadata.Builder newBuilderForType()
Returns
TypeDescription
RestoreDatabaseMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RestoreDatabaseMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RestoreDatabaseMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public RestoreDatabaseMetadata.Builder toBuilder()
Returns
TypeDescription
RestoreDatabaseMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException