Class PitrSnapshot (3.33.0)

public final class PitrSnapshot extends GeneratedMessageV3 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

Static Fields

DATABASE_FIELD_NUMBER

public static final int DATABASE_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_UID_FIELD_NUMBER

public static final int DATABASE_UID_FIELD_NUMBER
Field Value
Type Description
int

SNAPSHOT_TIME_FIELD_NUMBER

public static final int SNAPSHOT_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PitrSnapshot getDefaultInstance()
Returns
Type Description
PitrSnapshot

getDescriptor()

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

newBuilder()

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

newBuilder(PitrSnapshot prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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()
Returns
Type Description
PitrSnapshot

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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.

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.

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 PitrSnapshot.Builder newBuilderForType()
Returns
Type Description
PitrSnapshot.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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