.TH "GCLOUD_FIRESTORE_BACKUPS_SCHEDULES_CREATE" 1



.SH "NAME"
.HP
gcloud firestore backups schedules create \- creates a Cloud Firestore backup schedule



.SH "SYNOPSIS"
.HP
\f5gcloud firestore backups schedules create\fR \fB\-\-database\fR=\fIDATABASE\fR \fB\-\-retention\fR=\fIRETENTION\fR (\fB\-\-recurrence\fR=\fIRECURRENCE\fR\ :\ \fB\-\-day\-of\-week\fR=\fIDAY_OF_WEEK\fR) [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "EXAMPLES"

To create a backup schedule with 7 days retention and daily recurrence under
database testdb.

.RS 2m
$ gcloud firestore backups schedules create \-\-database=testdb \e
  \-\-retention=7d \-\-recurrence=daily
.RE

To create a backup schedule with 7 days retention and weekly recurrence on
Monday under database testdb.

.RS 2m
$ gcloud firestore backups schedules create \-\-database=testdb \e
  \-\-retention=7d \-\-recurrence=weekly \-\-day\-of\-week=MON
.RE



.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-database\fR=\fIDATABASE\fR

The database to operate on.

For example, to operate on database \f5foo\fR:

.RS 2m
$ gcloud firestore backups schedules create \-\-database='foo'
.RE

.TP 2m
\fB\-\-retention\fR=\fIRETENTION\fR

The rention of the backup. At what relative time in the future, compared to the
creation time of the backup should the backup be deleted, i.e. keep backups for
7 days.

For example, to set retention as 7 days.

.RS 2m
$ gcloud firestore backups schedules create \-\-retention=7d
.RE

.TP 2m

Recurrence settings of a backup schedule.

This must be specified.


.RS 2m
.TP 2m
\fB\-\-recurrence\fR=\fIRECURRENCE\fR

The recurrence settings of a backup schedule.

Currently only daily and weekly backup schedules are supported.

When a weekly backup schedule is created, day\-of\-week is needed.

For example, to create a weekly backup schedule which creates backups on Monday.

.RS 2m
$ gcloud firestore backups schedules create \-\-recurrence=weekly \e
    \-\-day\-of\-week=MON
.RE

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-day\-of\-week\fR=\fIDAY_OF_WEEK\fR

The day of week (UTC time zone) of when backups are created.

.RS 2m
The available values are: `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`,`SUN`.
Values are case insensitive.
.RE

.RS 2m
This is required when creating a weekly backup schedule.
.RE

\fIDAY_OF_WEEK\fR must be one of: \fBSUN\fR, \fBMON\fR, \fBTUE\fR, \fBWED\fR,
\fBTHU\fR, \fBFRI\fR, \fBSAT\fR.


.RE
.RE
.sp

.SH "GCLOUD WIDE FLAGS"

These flags are available to all commands: \-\-access\-token\-file, \-\-account,
\-\-billing\-project, \-\-configuration, \-\-flags\-file, \-\-flatten,
\-\-format, \-\-help, \-\-impersonate\-service\-account, \-\-log\-http,
\-\-project, \-\-quiet, \-\-trace\-token, \-\-user\-output\-enabled,
\-\-verbosity.

Run \fB$ gcloud help\fR for details.



.SH "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha firestore backups schedules create
.RE

.RS 2m
$ gcloud beta firestore backups schedules create
.RE