Class BackupSchedule (3.22.0)

public final class BackupSchedule extends GeneratedMessageV3 implements BackupScheduleOrBuilder

A backup schedule for a Cloud Firestore Database.

This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.

Protobuf type google.firestore.admin.v1.BackupSchedule

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DAILY_RECURRENCE_FIELD_NUMBER

public static final int DAILY_RECURRENCE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RETENTION_FIELD_NUMBER

public static final int RETENTION_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

WEEKLY_RECURRENCE_FIELD_NUMBER

public static final int WEEKLY_RECURRENCE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BackupSchedule getDefaultInstance()
Returns
Type Description
BackupSchedule

getDescriptor()

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

newBuilder()

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

newBuilder(BackupSchedule prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. The timestamp at which this backup schedule was created and effective since.

No backups will be created for this schedule before this time.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp at which this backup schedule was created and effective since.

No backups will be created for this schedule before this time.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDailyRecurrence()

public DailyRecurrence getDailyRecurrence()

For a schedule that runs daily.

.google.firestore.admin.v1.DailyRecurrence daily_recurrence = 7;

Returns
Type Description
DailyRecurrence

The dailyRecurrence.

getDailyRecurrenceOrBuilder()

public DailyRecurrenceOrBuilder getDailyRecurrenceOrBuilder()

For a schedule that runs daily.

.google.firestore.admin.v1.DailyRecurrence daily_recurrence = 7;

Returns
Type Description
DailyRecurrenceOrBuilder

getDefaultInstanceForType()

public BackupSchedule getDefaultInstanceForType()
Returns
Type Description
BackupSchedule

getName()

public String getName()

Output only. The unique backup schedule identifier across all locations and databases for the given project.

This will be auto-assigned.

Format is projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The unique backup schedule identifier across all locations and databases for the given project.

This will be auto-assigned.

Format is projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getRecurrenceCase()

public BackupSchedule.RecurrenceCase getRecurrenceCase()
Returns
Type Description
BackupSchedule.RecurrenceCase

getRetention()

public Duration getRetention()

At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.

.google.protobuf.Duration retention = 6;

Returns
Type Description
Duration

The retention.

getRetentionOrBuilder()

public DurationOrBuilder getRetentionOrBuilder()

At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.

.google.protobuf.Duration retention = 6;

Returns
Type Description
DurationOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getWeeklyRecurrence()

public WeeklyRecurrence getWeeklyRecurrence()

For a schedule that runs weekly on a specific day.

.google.firestore.admin.v1.WeeklyRecurrence weekly_recurrence = 8;

Returns
Type Description
WeeklyRecurrence

The weeklyRecurrence.

getWeeklyRecurrenceOrBuilder()

public WeeklyRecurrenceOrBuilder getWeeklyRecurrenceOrBuilder()

For a schedule that runs weekly on a specific day.

.google.firestore.admin.v1.WeeklyRecurrence weekly_recurrence = 8;

Returns
Type Description
WeeklyRecurrenceOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The timestamp at which this backup schedule was created and effective since.

No backups will be created for this schedule before this time.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDailyRecurrence()

public boolean hasDailyRecurrence()

For a schedule that runs daily.

.google.firestore.admin.v1.DailyRecurrence daily_recurrence = 7;

Returns
Type Description
boolean

Whether the dailyRecurrence field is set.

hasRetention()

public boolean hasRetention()

At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.

.google.protobuf.Duration retention = 6;

Returns
Type Description
boolean

Whether the retention field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hasWeeklyRecurrence()

public boolean hasWeeklyRecurrence()

For a schedule that runs weekly on a specific day.

.google.firestore.admin.v1.WeeklyRecurrence weekly_recurrence = 8;

Returns
Type Description
boolean

Whether the weeklyRecurrence 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 BackupSchedule.Builder newBuilderForType()
Returns
Type Description
BackupSchedule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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