1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="firestore_v1.html">Cloud Firestore API</a> . <a href="firestore_v1.projects.html">projects</a> . <a href="firestore_v1.projects.locations.html">locations</a> . <a href="firestore_v1.projects.locations.backups.html">backups</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a backup.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information about a backup.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the backups.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a backup.
Args:
name: string, Required. Name of the backup to delete. format is `projects/{project}/locations/{location}/backups/{backup}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets information about a backup.
Args:
name: string, Required. Name of the backup to fetch. Format is `projects/{project}/locations/{location}/backups/{backup}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A Backup of a Cloud Firestore Database. The backup contains all documents and index configurations for the given database at a specific point in time.
"database": "A String", # Output only. Name of the Firestore database that the backup is from. Format is `projects/{project}/databases/{database}`.
"databaseUid": "A String", # Output only. The system-generated UUID4 for the Firestore database that the backup is from.
"expireTime": "A String", # Output only. The timestamp at which this backup expires.
"name": "A String", # Output only. The unique resource name of the Backup. Format is `projects/{project}/locations/{location}/backups/{backup}`.
"snapshotTime": "A String", # Output only. The backup contains an externally consistent copy of the database at this time.
"state": "A String", # Output only. The current state of the backup.
"stats": { # Backup specific statistics. # Output only. Statistics about the backup. This data only becomes available after the backup is fully materialized to secondary storage. This field will be empty till then.
"documentCount": "A String", # Output only. The total number of documents contained in the backup.
"indexCount": "A String", # Output only. The total number of index entries contained in the backup.
"sizeBytes": "A String", # Output only. Summation of the size of all documents and index entries in the backup, measured in bytes.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, x__xgafv=None)</code>
<pre>Lists all the backups.
Args:
parent: string, Required. The location to list backups from. Format is `projects/{project}/locations/{location}`. Use `{location} = '-'` to list backups from all locations for the given project. This allows listing backups from a single location or from all locations. (required)
filter: string, An expression that filters the list of returned backups. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Backup are eligible for filtering: * `database_uid` (supports `=` only)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for FirestoreAdmin.ListBackups.
"backups": [ # List of all backups for the project.
{ # A Backup of a Cloud Firestore Database. The backup contains all documents and index configurations for the given database at a specific point in time.
"database": "A String", # Output only. Name of the Firestore database that the backup is from. Format is `projects/{project}/databases/{database}`.
"databaseUid": "A String", # Output only. The system-generated UUID4 for the Firestore database that the backup is from.
"expireTime": "A String", # Output only. The timestamp at which this backup expires.
"name": "A String", # Output only. The unique resource name of the Backup. Format is `projects/{project}/locations/{location}/backups/{backup}`.
"snapshotTime": "A String", # Output only. The backup contains an externally consistent copy of the database at this time.
"state": "A String", # Output only. The current state of the backup.
"stats": { # Backup specific statistics. # Output only. Statistics about the backup. This data only becomes available after the backup is fully materialized to secondary storage. This field will be empty till then.
"documentCount": "A String", # Output only. The total number of documents contained in the backup.
"indexCount": "A String", # Output only. The total number of index entries contained in the backup.
"sizeBytes": "A String", # Output only. Summation of the size of all documents and index entries in the backup, measured in bytes.
},
},
],
"unreachable": [ # List of locations that existing backups were not able to be fetched from. Instead of failing the entire requests when a single location is unreachable, this response returns a partial result set and list of locations unable to be reached here. The request can be retried against a single location to get a concrete error.
"A String",
],
}</pre>
</div>
</body></html>
|
