public static final class PitrSnapshot.Builder extends GeneratedMessage.Builder<PitrSnapshot.Builder> implements PitrSnapshotOrBuilderA 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
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > PitrSnapshot.BuilderImplements
PitrSnapshotOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public PitrSnapshot build()| Returns | |
|---|---|
| Type | Description |
PitrSnapshot |
|
buildPartial()
public PitrSnapshot buildPartial()| Returns | |
|---|---|
| Type | Description |
PitrSnapshot |
|
clear()
public PitrSnapshot.Builder clear()| Returns | |
|---|---|
| Type | Description |
PitrSnapshot.Builder |
|
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) = { ... }
| Returns | |
|---|---|
| Type | Description |
PitrSnapshot.Builder |
This builder for chaining. |
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];
| Returns | |
|---|---|
| Type | Description |
PitrSnapshot.Builder |
This builder for chaining. |
clearSnapshotTime()
public PitrSnapshot.Builder clearSnapshotTime()Required. Snapshot time of the database.
.google.protobuf.Timestamp snapshot_time = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
PitrSnapshot.Builder |
|
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()| Returns | |
|---|---|
| Type | Description |
PitrSnapshot |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getSnapshotTimeOrBuilder()
public TimestampOrBuilder getSnapshotTimeOrBuilder()Required. Snapshot time of the database.
.google.protobuf.Timestamp snapshot_time = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(PitrSnapshot other)
public PitrSnapshot.Builder mergeFrom(PitrSnapshot other)| Parameter | |
|---|---|
| Name | Description |
other |
PitrSnapshot |
| Returns | |
|---|---|
| Type | Description |
PitrSnapshot.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PitrSnapshot.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PitrSnapshot.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public PitrSnapshot.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
PitrSnapshot.Builder |
|
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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
PitrSnapshot.Builder |
|
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 |
StringThe database to set. |
| Returns | |
|---|---|
| Type | Description |
PitrSnapshot.Builder |
This builder for chaining. |
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 |
ByteStringThe bytes for database to set. |
| Returns | |
|---|---|
| Type | Description |
PitrSnapshot.Builder |
This builder for chaining. |
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 |
ByteStringThe databaseUid to set. |
| Returns | |
|---|---|
| Type | Description |
PitrSnapshot.Builder |
This builder for chaining. |
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];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
PitrSnapshot.Builder |
|
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 |
| Returns | |
|---|---|
| Type | Description |
PitrSnapshot.Builder |
|