Debian Codegraph @

docs/dyn/firestore_v1.projects.databases.backupSchedules.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="firestore_v1.html">Cloud Firestore API</a> . <a href="firestore_v1.projects.html">projects</a> . <a href="firestore_v1.projects.databases.html">databases</a> . <a href="firestore_v1.projects.databases.backupSchedules.html">backupSchedules</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule and one weekly backup schedule.</p>
83 <p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85 <p class="firstline">Deletes a backup schedule.</p>
86 <p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88 <p class="firstline">Gets information about a backup schedule.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
91 <p class="firstline">List backup schedules.</p>
92 <p class="toc_element">
93 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Updates a backup schedule.</p>
95 <h3>Method Details</h3>
96 <div class="method">
97 <code class="details" id="close">close()</code>
98 <pre>Close httplib2 connections.</pre>
99 </div>
100
101 <div class="method">
102 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
103 <pre>Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule and one weekly backup schedule.
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 &quot;createTime&quot;: &quot;A String&quot;, # 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 &quot;dailyRecurrence&quot;: { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily.
113 },
114 &quot;name&quot;: &quot;A String&quot;, # 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 &quot;retention&quot;: &quot;A String&quot;, # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks.
116 &quot;updateTime&quot;: &quot;A String&quot;, # 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 &quot;weeklyRecurrence&quot;: { # 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.
118 &quot;day&quot;: &quot;A String&quot;, # 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 &quot;createTime&quot;: &quot;A String&quot;, # 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 &quot;dailyRecurrence&quot;: { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily.
133 },
134 &quot;name&quot;: &quot;A String&quot;, # 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 &quot;retention&quot;: &quot;A String&quot;, # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks.
136 &quot;updateTime&quot;: &quot;A String&quot;, # 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 &quot;weeklyRecurrence&quot;: { # 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.
138 &quot;day&quot;: &quot;A String&quot;, # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
139 },
140 }</pre>
141 </div>
142
143 <div class="method">
144 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
145 <pre>Deletes a backup schedule.
146
147 Args:
148 name: string, Required. The name of the 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); }
158 }</pre>
159 </div>
160
161 <div class="method">
162 <code class="details" id="get">get(name, x__xgafv=None)</code>
163 <pre>Gets information about a backup schedule.
164
165 Args:
166 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 &quot;createTime&quot;: &quot;A String&quot;, # 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 &quot;dailyRecurrence&quot;: { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily.
178 },
179 &quot;name&quot;: &quot;A String&quot;, # 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 &quot;retention&quot;: &quot;A String&quot;, # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks.
181 &quot;updateTime&quot;: &quot;A String&quot;, # 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 &quot;weeklyRecurrence&quot;: { # 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.
183 &quot;day&quot;: &quot;A String&quot;, # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
184 },
185 }</pre>
186 </div>
187
188 <div class="method">
189 <code class="details" id="list">list(parent, x__xgafv=None)</code>
190 <pre>List backup schedules.
191
192 Args:
193 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 &quot;backupSchedules&quot;: [ # 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 &quot;createTime&quot;: &quot;A String&quot;, # 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 &quot;dailyRecurrence&quot;: { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily.
207 },
208 &quot;name&quot;: &quot;A String&quot;, # 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 &quot;retention&quot;: &quot;A String&quot;, # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks.
210 &quot;updateTime&quot;: &quot;A String&quot;, # 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 &quot;weeklyRecurrence&quot;: { # 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.
212 &quot;day&quot;: &quot;A String&quot;, # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
213 },
214 },
215 ],
216 }</pre>
217 </div>
218
219 <div class="method">
220 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
221 <pre>Updates a backup schedule.
222
223 Args:
224 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 &quot;createTime&quot;: &quot;A String&quot;, # 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 &quot;dailyRecurrence&quot;: { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily.
231 },
232 &quot;name&quot;: &quot;A String&quot;, # 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 &quot;retention&quot;: &quot;A String&quot;, # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks.
234 &quot;updateTime&quot;: &quot;A String&quot;, # 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 &quot;weeklyRecurrence&quot;: { # 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.
236 &quot;day&quot;: &quot;A String&quot;, # 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 &quot;createTime&quot;: &quot;A String&quot;, # 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 &quot;dailyRecurrence&quot;: { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily.
252 },
253 &quot;name&quot;: &quot;A String&quot;, # 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 &quot;retention&quot;: &quot;A String&quot;, # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks.
255 &quot;updateTime&quot;: &quot;A String&quot;, # 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 &quot;weeklyRecurrence&quot;: { # 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.
257 &quot;day&quot;: &quot;A String&quot;, # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
258 },
259 }</pre>
260 </div>
261
262 </body></html>