Class RestoreDatabaseMetadata.Builder (3.20.0)

public static final class RestoreDatabaseMetadata.Builder extends GeneratedMessageV3.Builder<RestoreDatabaseMetadata.Builder> implements RestoreDatabaseMetadataOrBuilder

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

Protobuf type google.firestore.admin.v1.RestoreDatabaseMetadata

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RestoreDatabaseMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RestoreDatabaseMetadata.Builder
Overrides

build()

public RestoreDatabaseMetadata build()
Returns
TypeDescription
RestoreDatabaseMetadata

buildPartial()

public RestoreDatabaseMetadata buildPartial()
Returns
TypeDescription
RestoreDatabaseMetadata

clear()

public RestoreDatabaseMetadata.Builder clear()
Returns
TypeDescription
RestoreDatabaseMetadata.Builder
Overrides

clearBackup()

public RestoreDatabaseMetadata.Builder clearBackup()

The name of the backup restoring from.

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

Returns
TypeDescription
RestoreDatabaseMetadata.Builder

This builder for chaining.

clearDatabase()

public RestoreDatabaseMetadata.Builder clearDatabase()

The name of the database being restored to.

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

Returns
TypeDescription
RestoreDatabaseMetadata.Builder

This builder for chaining.

clearEndTime()

public RestoreDatabaseMetadata.Builder clearEndTime()

The time the restore finished, unset for ongoing restores.

.google.protobuf.Timestamp end_time = 2;

Returns
TypeDescription
RestoreDatabaseMetadata.Builder

clearField(Descriptors.FieldDescriptor field)

public RestoreDatabaseMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
RestoreDatabaseMetadata.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public RestoreDatabaseMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
RestoreDatabaseMetadata.Builder
Overrides

clearOperationState()

public RestoreDatabaseMetadata.Builder clearOperationState()

The operation state of the restore.

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

Returns
TypeDescription
RestoreDatabaseMetadata.Builder

This builder for chaining.

clearProgressPercentage()

public RestoreDatabaseMetadata.Builder clearProgressPercentage()

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

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

Returns
TypeDescription
RestoreDatabaseMetadata.Builder

clearStartTime()

public RestoreDatabaseMetadata.Builder clearStartTime()

The time the restore was started.

.google.protobuf.Timestamp start_time = 1;

Returns
TypeDescription
RestoreDatabaseMetadata.Builder

clone()

public RestoreDatabaseMetadata.Builder clone()
Returns
TypeDescription
RestoreDatabaseMetadata.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEndTime()

public Timestamp getEndTime()

The time the restore finished, unset for ongoing restores.

.google.protobuf.Timestamp end_time = 2;

Returns
TypeDescription
Timestamp

The endTime.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

The time the restore finished, unset for ongoing restores.

.google.protobuf.Timestamp end_time = 2;

Returns
TypeDescription
Builder

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.

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.

getProgressPercentageBuilder()

public Progress.Builder getProgressPercentageBuilder()

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

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

Returns
TypeDescription
Progress.Builder

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

getStartTime()

public Timestamp getStartTime()

The time the restore was started.

.google.protobuf.Timestamp start_time = 1;

Returns
TypeDescription
Timestamp

The startTime.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

The time the restore was started.

.google.protobuf.Timestamp start_time = 1;

Returns
TypeDescription
Builder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeEndTime(Timestamp value)

public RestoreDatabaseMetadata.Builder mergeEndTime(Timestamp value)

The time the restore finished, unset for ongoing restores.

.google.protobuf.Timestamp end_time = 2;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
RestoreDatabaseMetadata.Builder

mergeFrom(RestoreDatabaseMetadata other)

public RestoreDatabaseMetadata.Builder mergeFrom(RestoreDatabaseMetadata other)
Parameter
NameDescription
otherRestoreDatabaseMetadata
Returns
TypeDescription
RestoreDatabaseMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RestoreDatabaseMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreDatabaseMetadata.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public RestoreDatabaseMetadata.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
RestoreDatabaseMetadata.Builder
Overrides

mergeProgressPercentage(Progress value)

public RestoreDatabaseMetadata.Builder mergeProgressPercentage(Progress value)

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

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

Parameter
NameDescription
valueProgress
Returns
TypeDescription
RestoreDatabaseMetadata.Builder

mergeStartTime(Timestamp value)

public RestoreDatabaseMetadata.Builder mergeStartTime(Timestamp value)

The time the restore was started.

.google.protobuf.Timestamp start_time = 1;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
RestoreDatabaseMetadata.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RestoreDatabaseMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RestoreDatabaseMetadata.Builder
Overrides

setBackup(String value)

public RestoreDatabaseMetadata.Builder setBackup(String value)

The name of the backup restoring from.

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

Parameter
NameDescription
valueString

The backup to set.

Returns
TypeDescription
RestoreDatabaseMetadata.Builder

This builder for chaining.

setBackupBytes(ByteString value)

public RestoreDatabaseMetadata.Builder setBackupBytes(ByteString value)

The name of the backup restoring from.

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

Parameter
NameDescription
valueByteString

The bytes for backup to set.

Returns
TypeDescription
RestoreDatabaseMetadata.Builder

This builder for chaining.

setDatabase(String value)

public RestoreDatabaseMetadata.Builder setDatabase(String value)

The name of the database being restored to.

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

Parameter
NameDescription
valueString

The database to set.

Returns
TypeDescription
RestoreDatabaseMetadata.Builder

This builder for chaining.

setDatabaseBytes(ByteString value)

public RestoreDatabaseMetadata.Builder setDatabaseBytes(ByteString value)

The name of the database being restored to.

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

Parameter
NameDescription
valueByteString

The bytes for database to set.

Returns
TypeDescription
RestoreDatabaseMetadata.Builder

This builder for chaining.

setEndTime(Timestamp value)

public RestoreDatabaseMetadata.Builder setEndTime(Timestamp value)

The time the restore finished, unset for ongoing restores.

.google.protobuf.Timestamp end_time = 2;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
RestoreDatabaseMetadata.Builder

setEndTime(Timestamp.Builder builderForValue)

public RestoreDatabaseMetadata.Builder setEndTime(Timestamp.Builder builderForValue)

The time the restore finished, unset for ongoing restores.

.google.protobuf.Timestamp end_time = 2;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
RestoreDatabaseMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RestoreDatabaseMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RestoreDatabaseMetadata.Builder
Overrides

setOperationState(OperationState value)

public RestoreDatabaseMetadata.Builder setOperationState(OperationState value)

The operation state of the restore.

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

Parameter
NameDescription
valueOperationState

The operationState to set.

Returns
TypeDescription
RestoreDatabaseMetadata.Builder

This builder for chaining.

setOperationStateValue(int value)

public RestoreDatabaseMetadata.Builder setOperationStateValue(int value)

The operation state of the restore.

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for operationState to set.

Returns
TypeDescription
RestoreDatabaseMetadata.Builder

This builder for chaining.

setProgressPercentage(Progress value)

public RestoreDatabaseMetadata.Builder setProgressPercentage(Progress value)

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

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

Parameter
NameDescription
valueProgress
Returns
TypeDescription
RestoreDatabaseMetadata.Builder

setProgressPercentage(Progress.Builder builderForValue)

public RestoreDatabaseMetadata.Builder setProgressPercentage(Progress.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueProgress.Builder
Returns
TypeDescription
RestoreDatabaseMetadata.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RestoreDatabaseMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
RestoreDatabaseMetadata.Builder
Overrides

setStartTime(Timestamp value)

public RestoreDatabaseMetadata.Builder setStartTime(Timestamp value)

The time the restore was started.

.google.protobuf.Timestamp start_time = 1;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
RestoreDatabaseMetadata.Builder

setStartTime(Timestamp.Builder builderForValue)

public RestoreDatabaseMetadata.Builder setStartTime(Timestamp.Builder builderForValue)

The time the restore was started.

.google.protobuf.Timestamp start_time = 1;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
RestoreDatabaseMetadata.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final RestoreDatabaseMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RestoreDatabaseMetadata.Builder
Overrides