Class BackupSchedule.Builder (3.22.0)

public static final class BackupSchedule.Builder extends GeneratedMessageV3.Builder<BackupSchedule.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BackupSchedule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BackupSchedule.Builder
Overrides

build()

public BackupSchedule build()
Returns
Type Description
BackupSchedule

buildPartial()

public BackupSchedule buildPartial()
Returns
Type Description
BackupSchedule

clear()

public BackupSchedule.Builder clear()
Returns
Type Description
BackupSchedule.Builder
Overrides

clearCreateTime()

public BackupSchedule.Builder clearCreateTime()

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
BackupSchedule.Builder

clearDailyRecurrence()

public BackupSchedule.Builder clearDailyRecurrence()

For a schedule that runs daily.

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

Returns
Type Description
BackupSchedule.Builder

clearField(Descriptors.FieldDescriptor field)

public BackupSchedule.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BackupSchedule.Builder
Overrides

clearName()

public BackupSchedule.Builder clearName()

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
BackupSchedule.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BackupSchedule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BackupSchedule.Builder
Overrides

clearRecurrence()

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

clearRetention()

public BackupSchedule.Builder clearRetention()

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
BackupSchedule.Builder

clearUpdateTime()

public BackupSchedule.Builder clearUpdateTime()

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
BackupSchedule.Builder

clearWeeklyRecurrence()

public BackupSchedule.Builder clearWeeklyRecurrence()

For a schedule that runs weekly on a specific day.

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

Returns
Type Description
BackupSchedule.Builder

clone()

public BackupSchedule.Builder clone()
Returns
Type Description
BackupSchedule.Builder
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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
Builder

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.

getDailyRecurrenceBuilder()

public DailyRecurrence.Builder getDailyRecurrenceBuilder()

For a schedule that runs daily.

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

Returns
Type Description
DailyRecurrence.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

getRetentionBuilder()

public Duration.Builder getRetentionBuilder()

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
Builder

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

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

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.

getWeeklyRecurrenceBuilder()

public WeeklyRecurrence.Builder getWeeklyRecurrenceBuilder()

For a schedule that runs weekly on a specific day.

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

Returns
Type Description
WeeklyRecurrence.Builder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public BackupSchedule.Builder mergeCreateTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
BackupSchedule.Builder

mergeDailyRecurrence(DailyRecurrence value)

public BackupSchedule.Builder mergeDailyRecurrence(DailyRecurrence value)

For a schedule that runs daily.

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

Parameter
Name Description
value DailyRecurrence
Returns
Type Description
BackupSchedule.Builder

mergeFrom(BackupSchedule other)

public BackupSchedule.Builder mergeFrom(BackupSchedule other)
Parameter
Name Description
other BackupSchedule
Returns
Type Description
BackupSchedule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BackupSchedule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackupSchedule.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BackupSchedule.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BackupSchedule.Builder
Overrides

mergeRetention(Duration value)

public BackupSchedule.Builder mergeRetention(Duration value)

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;

Parameter
Name Description
value Duration
Returns
Type Description
BackupSchedule.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BackupSchedule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BackupSchedule.Builder
Overrides

mergeUpdateTime(Timestamp value)

public BackupSchedule.Builder mergeUpdateTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
BackupSchedule.Builder

mergeWeeklyRecurrence(WeeklyRecurrence value)

public BackupSchedule.Builder mergeWeeklyRecurrence(WeeklyRecurrence value)

For a schedule that runs weekly on a specific day.

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

Parameter
Name Description
value WeeklyRecurrence
Returns
Type Description
BackupSchedule.Builder

setCreateTime(Timestamp value)

public BackupSchedule.Builder setCreateTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
BackupSchedule.Builder

setCreateTime(Timestamp.Builder builderForValue)

public BackupSchedule.Builder setCreateTime(Timestamp.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BackupSchedule.Builder

setDailyRecurrence(DailyRecurrence value)

public BackupSchedule.Builder setDailyRecurrence(DailyRecurrence value)

For a schedule that runs daily.

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

Parameter
Name Description
value DailyRecurrence
Returns
Type Description
BackupSchedule.Builder

setDailyRecurrence(DailyRecurrence.Builder builderForValue)

public BackupSchedule.Builder setDailyRecurrence(DailyRecurrence.Builder builderForValue)

For a schedule that runs daily.

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

Parameter
Name Description
builderForValue DailyRecurrence.Builder
Returns
Type Description
BackupSchedule.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public BackupSchedule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BackupSchedule.Builder
Overrides

setName(String value)

public BackupSchedule.Builder setName(String value)

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];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
BackupSchedule.Builder

This builder for chaining.

setNameBytes(ByteString value)

public BackupSchedule.Builder setNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
BackupSchedule.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BackupSchedule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BackupSchedule.Builder
Overrides

setRetention(Duration value)

public BackupSchedule.Builder setRetention(Duration value)

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;

Parameter
Name Description
value Duration
Returns
Type Description
BackupSchedule.Builder

setRetention(Duration.Builder builderForValue)

public BackupSchedule.Builder setRetention(Duration.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BackupSchedule.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final BackupSchedule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BackupSchedule.Builder
Overrides

setUpdateTime(Timestamp value)

public BackupSchedule.Builder setUpdateTime(Timestamp value)

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];

Parameter
Name Description
value Timestamp
Returns
Type Description
BackupSchedule.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public BackupSchedule.Builder setUpdateTime(Timestamp.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
BackupSchedule.Builder

setWeeklyRecurrence(WeeklyRecurrence value)

public BackupSchedule.Builder setWeeklyRecurrence(WeeklyRecurrence value)

For a schedule that runs weekly on a specific day.

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

Parameter
Name Description
value WeeklyRecurrence
Returns
Type Description
BackupSchedule.Builder

setWeeklyRecurrence(WeeklyRecurrence.Builder builderForValue)

public BackupSchedule.Builder setWeeklyRecurrence(WeeklyRecurrence.Builder builderForValue)

For a schedule that runs weekly on a specific day.

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

Parameter
Name Description
builderForValue WeeklyRecurrence.Builder
Returns
Type Description
BackupSchedule.Builder