You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<pclass="firstline">Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule with retention up to 7 days and one weekly backup schedule with retention up to 14 weeks.</p>
<pre>Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule with retention up to 7 days and one weekly backup schedule with retention up to 14 weeks.
104
+
105
+
Args:
106
+
parent: string, Required. The parent database. Format `projects/{project}/databases/{database}` (required)
107
+
body: object, The request body.
108
+
The object takes the form of:
109
+
110
+
{ # 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.
111
+
"createTime": "A String", # 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.
112
+
"dailyRecurrence": { # Represent a recurring schedule that runs at a specific time every day. The time zone is UTC. # For a schedule that runs daily at a specified time.
113
+
},
114
+
"name": "A String", # 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}`
115
+
"retention": "A String", # 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.
116
+
"updateTime": "A String", # 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.
117
+
"weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day and time.
118
+
"day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
119
+
},
120
+
}
121
+
122
+
x__xgafv: string, V1 error format.
123
+
Allowed values
124
+
1 - v1 error format
125
+
2 - v2 error format
126
+
127
+
Returns:
128
+
An object of the form:
129
+
130
+
{ # 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.
131
+
"createTime": "A String", # 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.
132
+
"dailyRecurrence": { # Represent a recurring schedule that runs at a specific time every day. The time zone is UTC. # For a schedule that runs daily at a specified time.
133
+
},
134
+
"name": "A String", # 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}`
135
+
"retention": "A String", # 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.
136
+
"updateTime": "A String", # 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.
137
+
"weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day and time.
138
+
"day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
name: string, Required. The name of backup schedule. Format `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` (required)
149
+
x__xgafv: string, V1 error format.
150
+
Allowed values
151
+
1 - v1 error format
152
+
2 - v2 error format
153
+
154
+
Returns:
155
+
An object of the form:
156
+
157
+
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
name: string, Required. The name of the backup schedule. Format `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` (required)
167
+
x__xgafv: string, V1 error format.
168
+
Allowed values
169
+
1 - v1 error format
170
+
2 - v2 error format
171
+
172
+
Returns:
173
+
An object of the form:
174
+
175
+
{ # 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.
176
+
"createTime": "A String", # 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.
177
+
"dailyRecurrence": { # Represent a recurring schedule that runs at a specific time every day. The time zone is UTC. # For a schedule that runs daily at a specified time.
178
+
},
179
+
"name": "A String", # 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}`
180
+
"retention": "A String", # 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.
181
+
"updateTime": "A String", # 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.
182
+
"weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day and time.
183
+
"day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
parent: string, Required. The parent database. Format is `projects/{project}/databases/{database}`. (required)
194
+
x__xgafv: string, V1 error format.
195
+
Allowed values
196
+
1 - v1 error format
197
+
2 - v2 error format
198
+
199
+
Returns:
200
+
An object of the form:
201
+
202
+
{ # The response for FirestoreAdmin.ListBackupSchedules.
203
+
"backupSchedules": [ # List of all backup schedules.
204
+
{ # 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.
205
+
"createTime": "A String", # 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.
206
+
"dailyRecurrence": { # Represent a recurring schedule that runs at a specific time every day. The time zone is UTC. # For a schedule that runs daily at a specified time.
207
+
},
208
+
"name": "A String", # 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}`
209
+
"retention": "A String", # 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.
210
+
"updateTime": "A String", # 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.
211
+
"weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day and time.
212
+
"day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
name: string, 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}` (required)
225
+
body: object, The request body.
226
+
The object takes the form of:
227
+
228
+
{ # 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.
229
+
"createTime": "A String", # 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.
230
+
"dailyRecurrence": { # Represent a recurring schedule that runs at a specific time every day. The time zone is UTC. # For a schedule that runs daily at a specified time.
231
+
},
232
+
"name": "A String", # 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}`
233
+
"retention": "A String", # 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.
234
+
"updateTime": "A String", # 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.
235
+
"weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day and time.
236
+
"day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
237
+
},
238
+
}
239
+
240
+
updateMask: string, The list of fields to be updated.
241
+
x__xgafv: string, V1 error format.
242
+
Allowed values
243
+
1 - v1 error format
244
+
2 - v2 error format
245
+
246
+
Returns:
247
+
An object of the form:
248
+
249
+
{ # 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.
250
+
"createTime": "A String", # 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.
251
+
"dailyRecurrence": { # Represent a recurring schedule that runs at a specific time every day. The time zone is UTC. # For a schedule that runs daily at a specified time.
252
+
},
253
+
"name": "A String", # 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}`
254
+
"retention": "A String", # 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.
255
+
"updateTime": "A String", # 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.
256
+
"weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day and time.
257
+
"day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
0 commit comments