public static final class Backup.Builder extends GeneratedMessageV3.Builder<Backup.Builder> implements BackupOrBuilder
A Backup of a Cloud Firestore Database.
The backup contains all documents and index configurations for the given database at a specific point in time.
Protobuf type google.firestore.admin.v1.Backup
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Backup.BuilderImplements
BackupOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Backup.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Backup.Builder |
build()
public Backup build()
Returns | |
---|---|
Type | Description |
Backup |
buildPartial()
public Backup buildPartial()
Returns | |
---|---|
Type | Description |
Backup |
clear()
public Backup.Builder clear()
Returns | |
---|---|
Type | Description |
Backup.Builder |
clearDatabase()
public Backup.Builder clearDatabase()
Output only. Name of the Firestore database that the backup is from.
Format is projects/{project}/databases/{database}
.
string database = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
clearDatabaseUid()
public Backup.Builder clearDatabaseUid()
Output only. The system-generated UUID4 for the Firestore database that the backup is from.
string database_uid = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
clearExpireTime()
public Backup.Builder clearExpireTime()
Output only. The timestamp at which this backup expires.
.google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Backup.Builder |
clearField(Descriptors.FieldDescriptor field)
public Backup.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
Backup.Builder |
clearName()
public Backup.Builder clearName()
Output only. The unique resource name of the Backup.
Format is projects/{project}/locations/{location}/backups/{backup}
.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Backup.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
Backup.Builder |
clearSnapshotTime()
public Backup.Builder clearSnapshotTime()
Output only. The backup contains an externally consistent copy of the database at this time.
.google.protobuf.Timestamp snapshot_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Backup.Builder |
clearState()
public Backup.Builder clearState()
Output only. The current state of the backup.
.google.firestore.admin.v1.Backup.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
clearStats()
public Backup.Builder clearStats()
Output only. Statistics about the backup.
This data only becomes available after the backup is fully materialized to secondary storage. This field will be empty till then.
.google.firestore.admin.v1.Backup.Stats stats = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Backup.Builder |
clone()
public Backup.Builder clone()
Returns | |
---|---|
Type | Description |
Backup.Builder |
getDatabase()
public String getDatabase()
Output only. Name of the Firestore database that the backup is from.
Format is projects/{project}/databases/{database}
.
string database = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String |
The database. |
getDatabaseBytes()
public ByteString getDatabaseBytes()
Output only. Name of the Firestore database that the backup is from.
Format is projects/{project}/databases/{database}
.
string database = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for database. |
getDatabaseUid()
public String getDatabaseUid()
Output only. The system-generated UUID4 for the Firestore database that the backup is from.
string database_uid = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String |
The databaseUid. |
getDatabaseUidBytes()
public ByteString getDatabaseUidBytes()
Output only. The system-generated UUID4 for the Firestore database that the backup is from.
string database_uid = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for databaseUid. |
getDefaultInstanceForType()
public Backup getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Backup |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getExpireTime()
public Timestamp getExpireTime()
Output only. The timestamp at which this backup expires.
.google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp |
The expireTime. |
getExpireTimeBuilder()
public Timestamp.Builder getExpireTimeBuilder()
Output only. The timestamp at which this backup expires.
.google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getExpireTimeOrBuilder()
public TimestampOrBuilder getExpireTimeOrBuilder()
Output only. The timestamp at which this backup expires.
.google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getName()
public String getName()
Output only. The unique resource name of the Backup.
Format is projects/{project}/locations/{location}/backups/{backup}
.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()
Output only. The unique resource name of the Backup.
Format is projects/{project}/locations/{location}/backups/{backup}
.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
getSnapshotTime()
public Timestamp getSnapshotTime()
Output only. The backup contains an externally consistent copy of the database at this time.
.google.protobuf.Timestamp snapshot_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp |
The snapshotTime. |
getSnapshotTimeBuilder()
public Timestamp.Builder getSnapshotTimeBuilder()
Output only. The backup contains an externally consistent copy of the database at this time.
.google.protobuf.Timestamp snapshot_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getSnapshotTimeOrBuilder()
public TimestampOrBuilder getSnapshotTimeOrBuilder()
Output only. The backup contains an externally consistent copy of the database at this time.
.google.protobuf.Timestamp snapshot_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getState()
public Backup.State getState()
Output only. The current state of the backup.
.google.firestore.admin.v1.Backup.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Backup.State |
The state. |
getStateValue()
public int getStateValue()
Output only. The current state of the backup.
.google.firestore.admin.v1.Backup.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for state. |
getStats()
public Backup.Stats getStats()
Output only. Statistics about the backup.
This data only becomes available after the backup is fully materialized to secondary storage. This field will be empty till then.
.google.firestore.admin.v1.Backup.Stats stats = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Backup.Stats |
The stats. |
getStatsBuilder()
public Backup.Stats.Builder getStatsBuilder()
Output only. Statistics about the backup.
This data only becomes available after the backup is fully materialized to secondary storage. This field will be empty till then.
.google.firestore.admin.v1.Backup.Stats stats = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Backup.Stats.Builder |
getStatsOrBuilder()
public Backup.StatsOrBuilder getStatsOrBuilder()
Output only. Statistics about the backup.
This data only becomes available after the backup is fully materialized to secondary storage. This field will be empty till then.
.google.firestore.admin.v1.Backup.Stats stats = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Backup.StatsOrBuilder |
hasExpireTime()
public boolean hasExpireTime()
Output only. The timestamp at which this backup expires.
.google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
Whether the expireTime field is set. |
hasSnapshotTime()
public boolean hasSnapshotTime()
Output only. The backup contains an externally consistent copy of the database at this time.
.google.protobuf.Timestamp snapshot_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
Whether the snapshotTime field is set. |
hasStats()
public boolean hasStats()
Output only. Statistics about the backup.
This data only becomes available after the backup is fully materialized to secondary storage. This field will be empty till then.
.google.firestore.admin.v1.Backup.Stats stats = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
Whether the stats field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeExpireTime(Timestamp value)
public Backup.Builder mergeExpireTime(Timestamp value)
Output only. The timestamp at which this backup expires.
.google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Backup.Builder |
mergeFrom(Backup other)
public Backup.Builder mergeFrom(Backup other)
Parameter | |
---|---|
Name | Description |
other |
Backup |
Returns | |
---|---|
Type | Description |
Backup.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Backup.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Backup.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public Backup.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
Backup.Builder |
mergeSnapshotTime(Timestamp value)
public Backup.Builder mergeSnapshotTime(Timestamp value)
Output only. The backup contains an externally consistent copy of the database at this time.
.google.protobuf.Timestamp snapshot_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Backup.Builder |
mergeStats(Backup.Stats value)
public Backup.Builder mergeStats(Backup.Stats value)
Output only. Statistics about the backup.
This data only becomes available after the backup is fully materialized to secondary storage. This field will be empty till then.
.google.firestore.admin.v1.Backup.Stats stats = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Backup.Stats |
Returns | |
---|---|
Type | Description |
Backup.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Backup.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setDatabase(String value)
public Backup.Builder setDatabase(String value)
Output only. Name of the Firestore database that the backup is from.
Format is projects/{project}/databases/{database}
.
string database = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The database to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setDatabaseBytes(ByteString value)
public Backup.Builder setDatabaseBytes(ByteString value)
Output only. Name of the Firestore database that the backup is from.
Format is projects/{project}/databases/{database}
.
string database = 2 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for database to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setDatabaseUid(String value)
public Backup.Builder setDatabaseUid(String value)
Output only. The system-generated UUID4 for the Firestore database that the backup is from.
string database_uid = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
String The databaseUid to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setDatabaseUidBytes(ByteString value)
public Backup.Builder setDatabaseUidBytes(ByteString value)
Output only. The system-generated UUID4 for the Firestore database that the backup is from.
string database_uid = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for databaseUid to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setExpireTime(Timestamp value)
public Backup.Builder setExpireTime(Timestamp value)
Output only. The timestamp at which this backup expires.
.google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setExpireTime(Timestamp.Builder builderForValue)
public Backup.Builder setExpireTime(Timestamp.Builder builderForValue)
Output only. The timestamp at which this backup expires.
.google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public Backup.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setName(String value)
public Backup.Builder setName(String value)
Output only. The unique resource name of the Backup.
Format is projects/{project}/locations/{location}/backups/{backup}
.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Backup.Builder setNameBytes(ByteString value)
Output only. The unique resource name of the Backup.
Format is projects/{project}/locations/{location}/backups/{backup}
.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Backup.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setSnapshotTime(Timestamp value)
public Backup.Builder setSnapshotTime(Timestamp value)
Output only. The backup contains an externally consistent copy of the database at this time.
.google.protobuf.Timestamp snapshot_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setSnapshotTime(Timestamp.Builder builderForValue)
public Backup.Builder setSnapshotTime(Timestamp.Builder builderForValue)
Output only. The backup contains an externally consistent copy of the database at this time.
.google.protobuf.Timestamp snapshot_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setState(Backup.State value)
public Backup.Builder setState(Backup.State value)
Output only. The current state of the backup.
.google.firestore.admin.v1.Backup.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Backup.State The state to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setStateValue(int value)
public Backup.Builder setStateValue(int value)
Output only. The current state of the backup.
.google.firestore.admin.v1.Backup.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
int The enum numeric value on the wire for state to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setStats(Backup.Stats value)
public Backup.Builder setStats(Backup.Stats value)
Output only. Statistics about the backup.
This data only becomes available after the backup is fully materialized to secondary storage. This field will be empty till then.
.google.firestore.admin.v1.Backup.Stats stats = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Backup.Stats |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setStats(Backup.Stats.Builder builderForValue)
public Backup.Builder setStats(Backup.Stats.Builder builderForValue)
Output only. Statistics about the backup.
This data only becomes available after the backup is fully materialized to secondary storage. This field will be empty till then.
.google.firestore.admin.v1.Backup.Stats stats = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Backup.Stats.Builder |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final Backup.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Backup.Builder |