Class CloneDatabaseMetadata (3.33.0)

public final class CloneDatabaseMetadata extends GeneratedMessageV3 implements CloneDatabaseMetadataOrBuilder

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

Protobuf type google.firestore.admin.v1.CloneDatabaseMetadata

Static Fields

DATABASE_FIELD_NUMBER

public static final int DATABASE_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

OPERATION_STATE_FIELD_NUMBER

public static final int OPERATION_STATE_FIELD_NUMBER
Field Value
Type Description
int

PITR_SNAPSHOT_FIELD_NUMBER

public static final int PITR_SNAPSHOT_FIELD_NUMBER
Field Value
Type Description
int

PROGRESS_PERCENTAGE_FIELD_NUMBER

public static final int PROGRESS_PERCENTAGE_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CloneDatabaseMetadata getDefaultInstance()
Returns
Type Description
CloneDatabaseMetadata

getDescriptor()

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

newBuilder()

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

newBuilder(CloneDatabaseMetadata prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDatabase()

public String getDatabase()

The name of the database being cloned to.

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

Returns
Type Description
String

The database.

getDatabaseBytes()

public ByteString getDatabaseBytes()

The name of the database being cloned to.

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

Returns
Type Description
ByteString

The bytes for database.

getDefaultInstanceForType()

public CloneDatabaseMetadata getDefaultInstanceForType()
Returns
Type Description
CloneDatabaseMetadata

getEndTime()

public Timestamp getEndTime()

The time the clone finished, unset for ongoing clones.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

The time the clone finished, unset for ongoing clones.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
TimestampOrBuilder

getOperationState()

public OperationState getOperationState()

The operation state of the clone.

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

Returns
Type Description
OperationState

The operationState.

getOperationStateValue()

public int getOperationStateValue()

The operation state of the clone.

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

Returns
Type Description
int

The enum numeric value on the wire for operationState.

getParserForType()

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

getPitrSnapshot()

public PitrSnapshot getPitrSnapshot()

The snapshot from which this database was cloned.

.google.firestore.admin.v1.PitrSnapshot pitr_snapshot = 7;

Returns
Type Description
PitrSnapshot

The pitrSnapshot.

getPitrSnapshotOrBuilder()

public PitrSnapshotOrBuilder getPitrSnapshotOrBuilder()

The snapshot from which this database was cloned.

.google.firestore.admin.v1.PitrSnapshot pitr_snapshot = 7;

Returns
Type Description
PitrSnapshotOrBuilder

getProgressPercentage()

public Progress getProgressPercentage()

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

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

Returns
Type Description
Progress

The progressPercentage.

getProgressPercentageOrBuilder()

public ProgressOrBuilder getProgressPercentageOrBuilder()

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

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

Returns
Type Description
ProgressOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

public Timestamp getStartTime()

The time the clone was started.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

The time the clone was started.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
TimestampOrBuilder

hasEndTime()

public boolean hasEndTime()

The time the clone finished, unset for ongoing clones.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
boolean

Whether the endTime field is set.

hasPitrSnapshot()

public boolean hasPitrSnapshot()

The snapshot from which this database was cloned.

.google.firestore.admin.v1.PitrSnapshot pitr_snapshot = 7;

Returns
Type Description
boolean

Whether the pitrSnapshot field is set.

hasProgressPercentage()

public boolean hasProgressPercentage()

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

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

Returns
Type Description
boolean

Whether the progressPercentage field is set.

hasStartTime()

public boolean hasStartTime()

The time the clone was started.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
boolean

Whether the startTime 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 CloneDatabaseMetadata.Builder newBuilderForType()
Returns
Type Description
CloneDatabaseMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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