public static final class PitrSnapshot.Builder extends GeneratedMessageV3.Builder<PitrSnapshot.Builder> implements PitrSnapshotOrBuilder
A consistent snapshot of a database at a specific point in time.
A PITR (Point-in-time recovery) snapshot with previous versions of a
database's data is available for every minute up to the associated database's
data retention period. If the PITR feature is enabled, the retention period
is 7 days; otherwise, it is one hour.
Protobuf type google.firestore.admin.v1.PitrSnapshot
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PitrSnapshot.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public PitrSnapshot build()
buildPartial()
public PitrSnapshot buildPartial()
clear()
public PitrSnapshot.Builder clear()
Overrides
clearDatabase()
public PitrSnapshot.Builder clearDatabase()
Required. The name of the database that this was a snapshot of. Format:
projects/{project}/databases/{database}.
string database = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
clearDatabaseUid()
public PitrSnapshot.Builder clearDatabaseUid()
Output only. Public UUID of the database the snapshot was associated with.
bytes database_uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
clearField(Descriptors.FieldDescriptor field)
public PitrSnapshot.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public PitrSnapshot.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearSnapshotTime()
public PitrSnapshot.Builder clearSnapshotTime()
Required. Snapshot time of the database.
.google.protobuf.Timestamp snapshot_time = 3 [(.google.api.field_behavior) = REQUIRED];
clone()
public PitrSnapshot.Builder clone()
Overrides
getDatabase()
public String getDatabase()
Required. The name of the database that this was a snapshot of. Format:
projects/{project}/databases/{database}.
string database = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The database.
|
getDatabaseBytes()
public ByteString getDatabaseBytes()
Required. The name of the database that this was a snapshot of. Format:
projects/{project}/databases/{database}.
string database = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for database.
|
getDatabaseUid()
public ByteString getDatabaseUid()
Output only. Public UUID of the database the snapshot was associated with.
bytes database_uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The databaseUid.
|
getDefaultInstanceForType()
public PitrSnapshot getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getSnapshotTime()
public Timestamp getSnapshotTime()
Required. Snapshot time of the database.
.google.protobuf.Timestamp snapshot_time = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
Timestamp |
The snapshotTime.
|
getSnapshotTimeBuilder()
public Timestamp.Builder getSnapshotTimeBuilder()
Required. Snapshot time of the database.
.google.protobuf.Timestamp snapshot_time = 3 [(.google.api.field_behavior) = REQUIRED];
getSnapshotTimeOrBuilder()
public TimestampOrBuilder getSnapshotTimeOrBuilder()
Required. Snapshot time of the database.
.google.protobuf.Timestamp snapshot_time = 3 [(.google.api.field_behavior) = REQUIRED];
hasSnapshotTime()
public boolean hasSnapshotTime()
Required. Snapshot time of the database.
.google.protobuf.Timestamp snapshot_time = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the snapshotTime field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(PitrSnapshot other)
public PitrSnapshot.Builder mergeFrom(PitrSnapshot other)
public PitrSnapshot.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public PitrSnapshot.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
mergeSnapshotTime(Timestamp value)
public PitrSnapshot.Builder mergeSnapshotTime(Timestamp value)
Required. Snapshot time of the database.
.google.protobuf.Timestamp snapshot_time = 3 [(.google.api.field_behavior) = REQUIRED];
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PitrSnapshot.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setDatabase(String value)
public PitrSnapshot.Builder setDatabase(String value)
Required. The name of the database that this was a snapshot of. Format:
projects/{project}/databases/{database}.
string database = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter |
| Name |
Description |
value |
String
The database to set.
|
setDatabaseBytes(ByteString value)
public PitrSnapshot.Builder setDatabaseBytes(ByteString value)
Required. The name of the database that this was a snapshot of. Format:
projects/{project}/databases/{database}.
string database = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter |
| Name |
Description |
value |
ByteString
The bytes for database to set.
|
setDatabaseUid(ByteString value)
public PitrSnapshot.Builder setDatabaseUid(ByteString value)
Output only. Public UUID of the database the snapshot was associated with.
bytes database_uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
value |
ByteString
The databaseUid to set.
|
setField(Descriptors.FieldDescriptor field, Object value)
public PitrSnapshot.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PitrSnapshot.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setSnapshotTime(Timestamp value)
public PitrSnapshot.Builder setSnapshotTime(Timestamp value)
Required. Snapshot time of the database.
.google.protobuf.Timestamp snapshot_time = 3 [(.google.api.field_behavior) = REQUIRED];
setSnapshotTime(Timestamp.Builder builderForValue)
public PitrSnapshot.Builder setSnapshotTime(Timestamp.Builder builderForValue)
Required. Snapshot time of the database.
.google.protobuf.Timestamp snapshot_time = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
builderForValue |
Builder
|
setUnknownFields(UnknownFieldSet unknownFields)
public final PitrSnapshot.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
