Skip to content

Commit 46f26e4

Browse files
feat(firestore): update the api
#### firestore:v1 The following keys were deleted: - resources.projects.resources.databases.methods.delete.parameters.freeId (Total Keys: 2)
1 parent 846191d commit 46f26e4

File tree

6 files changed

+329
-295
lines changed

6 files changed

+329
-295
lines changed

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

Lines changed: 297 additions & 261 deletions
Large diffs are not rendered by default.

docs/dyn/firestore_v1.projects.databases.html

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ <h2>Instance Methods</h2>
9696
<code><a href="#create">create(parent, body=None, databaseId=None, x__xgafv=None)</a></code></p>
9797
<p class="firstline">Create a database.</p>
9898
<p class="toc_element">
99-
<code><a href="#delete">delete(name, allowMissing=None, etag=None, freeId=None, validateOnly=None, x__xgafv=None)</a></code></p>
99+
<code><a href="#delete">delete(name, allowMissing=None, etag=None, validateOnly=None, x__xgafv=None)</a></code></p>
100100
<p class="firstline">Deletes a database.</p>
101101
<p class="toc_element">
102102
<code><a href="#exportDocuments">exportDocuments(name, body=None, x__xgafv=None)</a></code></p>
@@ -141,7 +141,7 @@ <h3>Method Details</h3>
141141
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database.
142142
}
143143

144-
databaseId: string, Required. The ID to use for the database, which will become the final component of the database&#x27;s resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. &quot;(default)&quot; database id is also valid.
144+
databaseId: string, Required. The ID to use for the database, which will become the final component of the database&#x27;s resource name. The value must be set to &quot;(default)&quot;.
145145
x__xgafv: string, V1 error format.
146146
Allowed values
147147
1 - v1 error format
@@ -172,14 +172,13 @@ <h3>Method Details</h3>
172172
</div>
173173

174174
<div class="method">
175-
<code class="details" id="delete">delete(name, allowMissing=None, etag=None, freeId=None, validateOnly=None, x__xgafv=None)</code>
175+
<code class="details" id="delete">delete(name, allowMissing=None, etag=None, validateOnly=None, x__xgafv=None)</code>
176176
<pre>Deletes a database.
177177

178178
Args:
179179
name: string, Required. A name of the form `projects/{project_id}/databases/{database_id}` (required)
180180
allowMissing: boolean, If set to true and the Database is not found, the request will succeed but no action will be taken.
181181
etag: string, The current etag of the Database. If an etag is provided and does not match the current etag of the database, deletion will be blocked and a FAILED_PRECONDITION error will be returned.
182-
freeId: boolean, If set, will free the database_id associated with this database. uid will be used as the resource id to identify this deleted database.
183182
validateOnly: boolean, If set, validate the request and preview the response, but do not actually delete the database.
184183
x__xgafv: string, V1 error format.
185184
Allowed values

docs/dyn/firestore_v1beta1.projects.databases.documents.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ <h2>Instance Methods</h2>
118118
<p class="firstline">Retrieves the next page of results.</p>
119119
<p class="toc_element">
120120
<code><a href="#listen">listen(database, body=None, x__xgafv=None)</a></code></p>
121-
<p class="firstline">Listens to changes. This method is only available via the gRPC API (not REST).</p>
121+
<p class="firstline">Listens to changes. This method is only available via gRPC or WebChannel (not REST).</p>
122122
<p class="toc_element">
123123
<code><a href="#partitionQuery">partitionQuery(parent, body=None, x__xgafv=None)</a></code></p>
124124
<p class="firstline">Partitions a query by returning partition cursors that can be used to run the query in parallel. The returned partition cursors are split points that can be used by RunQuery as starting/end points for the query results.</p>
@@ -139,7 +139,7 @@ <h2>Instance Methods</h2>
139139
<p class="firstline">Runs a query.</p>
140140
<p class="toc_element">
141141
<code><a href="#write">write(database, body=None, x__xgafv=None)</a></code></p>
142-
<p class="firstline">Streams batches of document updates and deletes, in order. This method is only available via the gRPC API (not REST).</p>
142+
<p class="firstline">Streams batches of document updates and deletes, in order. This method is only available via gRPC or WebChannel (not REST).</p>
143143
<h3>Method Details</h3>
144144
<div class="method">
145145
<code class="details" id="batchGet">batchGet(database, body=None, x__xgafv=None)</code>
@@ -1179,7 +1179,7 @@ <h3>Method Details</h3>
11791179

11801180
<div class="method">
11811181
<code class="details" id="listen">listen(database, body=None, x__xgafv=None)</code>
1182-
<pre>Listens to changes. This method is only available via the gRPC API (not REST).
1182+
<pre>Listens to changes. This method is only available via gRPC or WebChannel (not REST).
11831183

11841184
Args:
11851185
database: string, Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. (required)
@@ -1242,7 +1242,7 @@ <h3>Method Details</h3>
12421242
},
12431243
},
12441244
],
1245-
&quot;select&quot;: { # The projection of document&#x27;s fields to return. # The projection to return.
1245+
&quot;select&quot;: { # The projection of document&#x27;s fields to return. # Optional sub-set of the fields to return. This acts as a DocumentMask over the documents returned from a query. When not set, assumes that the caller wants all fields returned.
12461246
&quot;fields&quot;: [ # The fields to return. If empty, all fields are returned. To only return the name of the document, use `[&#x27;__name__&#x27;]`.
12471247
{ # A reference to a field in a document, ex: `stats.operations`.
12481248
&quot;fieldPath&quot;: &quot;A String&quot;, # The relative path of the document being referenced. Requires: * Conform to document field name limitations.
@@ -1480,7 +1480,7 @@ <h3>Method Details</h3>
14801480
},
14811481
},
14821482
],
1483-
&quot;select&quot;: { # The projection of document&#x27;s fields to return. # The projection to return.
1483+
&quot;select&quot;: { # The projection of document&#x27;s fields to return. # Optional sub-set of the fields to return. This acts as a DocumentMask over the documents returned from a query. When not set, assumes that the caller wants all fields returned.
14841484
&quot;fields&quot;: [ # The fields to return. If empty, all fields are returned. To only return the name of the document, use `[&#x27;__name__&#x27;]`.
14851485
{ # A reference to a field in a document, ex: `stats.operations`.
14861486
&quot;fieldPath&quot;: &quot;A String&quot;, # The relative path of the document being referenced. Requires: * Conform to document field name limitations.
@@ -1806,7 +1806,7 @@ <h3>Method Details</h3>
18061806
},
18071807
},
18081808
],
1809-
&quot;select&quot;: { # The projection of document&#x27;s fields to return. # The projection to return.
1809+
&quot;select&quot;: { # The projection of document&#x27;s fields to return. # Optional sub-set of the fields to return. This acts as a DocumentMask over the documents returned from a query. When not set, assumes that the caller wants all fields returned.
18101810
&quot;fields&quot;: [ # The fields to return. If empty, all fields are returned. To only return the name of the document, use `[&#x27;__name__&#x27;]`.
18111811
{ # A reference to a field in a document, ex: `stats.operations`.
18121812
&quot;fieldPath&quot;: &quot;A String&quot;, # The relative path of the document being referenced. Requires: * Conform to document field name limitations.
@@ -1900,7 +1900,7 @@ <h3>Method Details</h3>
19001900
An object of the form:
19011901

19021902
{ # The response for Firestore.RunAggregationQuery.
1903-
&quot;readTime&quot;: &quot;A String&quot;, # The time at which the aggregate value is valid for.
1903+
&quot;readTime&quot;: &quot;A String&quot;, # The time at which the aggregate result was computed. This is always monotonically increasing; in this case, the previous AggregationResult in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `result` will be sent, and this represents the time at which the query was run.
19041904
&quot;result&quot;: { # The result of a single bucket from a Firestore aggregation query. The keys of `aggregate_fields` are the same for all results in an aggregation query, unlike document queries which can have different fields present for each result. # A single aggregation result. Not present when reporting partial progress.
19051905
&quot;aggregateFields&quot;: { # The result of the aggregation functions, ex: `COUNT(*) AS total_docs`. The key is the alias assigned to the aggregation function on input and the size of this map equals the number of aggregation functions in the query.
19061906
&quot;a_key&quot;: { # A message that can hold any of the supported value types.
@@ -1998,7 +1998,7 @@ <h3>Method Details</h3>
19981998
},
19991999
},
20002000
],
2001-
&quot;select&quot;: { # The projection of document&#x27;s fields to return. # The projection to return.
2001+
&quot;select&quot;: { # The projection of document&#x27;s fields to return. # Optional sub-set of the fields to return. This acts as a DocumentMask over the documents returned from a query. When not set, assumes that the caller wants all fields returned.
20022002
&quot;fields&quot;: [ # The fields to return. If empty, all fields are returned. To only return the name of the document, use `[&#x27;__name__&#x27;]`.
20032003
{ # A reference to a field in a document, ex: `stats.operations`.
20042004
&quot;fieldPath&quot;: &quot;A String&quot;, # The relative path of the document being referenced. Requires: * Conform to document field name limitations.
@@ -2131,7 +2131,7 @@ <h3>Method Details</h3>
21312131

21322132
<div class="method">
21332133
<code class="details" id="write">write(database, body=None, x__xgafv=None)</code>
2134-
<pre>Streams batches of document updates and deletes, in order. This method is only available via the gRPC API (not REST).
2134+
<pre>Streams batches of document updates and deletes, in order. This method is only available via gRPC or WebChannel (not REST).
21352135

21362136
Args:
21372137
database: string, Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. This is only required in the first message. (required)

googleapiclient/discovery_cache/documents/firestore.v1.json

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@
122122
],
123123
"parameters": {
124124
"databaseId": {
125-
"description": "Required. The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. \"(default)\" database id is also valid.",
125+
"description": "Required. The ID to use for the database, which will become the final component of the database's resource name. The value must be set to \"(default)\".",
126126
"location": "query",
127127
"type": "string"
128128
},
@@ -165,11 +165,6 @@
165165
"location": "query",
166166
"type": "string"
167167
},
168-
"freeId": {
169-
"description": "If set, will free the database_id associated with this database. uid will be used as the resource id to identify this deleted database.",
170-
"location": "query",
171-
"type": "boolean"
172-
},
173168
"name": {
174169
"description": "Required. A name of the form `projects/{project_id}/databases/{database_id}`",
175170
"location": "path",
@@ -997,7 +992,7 @@
997992
]
998993
},
999994
"listen": {
1000-
"description": "Listens to changes. This method is only available via the gRPC API (not REST).",
995+
"description": "Listens to changes. This method is only available via gRPC or WebChannel (not REST).",
1001996
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/documents:listen",
1002997
"httpMethod": "POST",
1003998
"id": "firestore.projects.databases.documents.listen",
@@ -1194,7 +1189,7 @@
11941189
]
11951190
},
11961191
"write": {
1197-
"description": "Streams batches of document updates and deletes, in order. This method is only available via the gRPC API (not REST).",
1192+
"description": "Streams batches of document updates and deletes, in order. This method is only available via gRPC or WebChannel (not REST).",
11981193
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}/documents:write",
11991194
"httpMethod": "POST",
12001195
"id": "firestore.projects.databases.documents.write",
@@ -1428,7 +1423,7 @@
14281423
}
14291424
}
14301425
},
1431-
"revision": "20230214",
1426+
"revision": "20230228",
14321427
"rootUrl": "https://firestore.googleapis.com/",
14331428
"schemas": {
14341429
"Aggregation": {
@@ -1664,11 +1659,13 @@
16641659
"description": "The operator for combining multiple filters.",
16651660
"enum": [
16661661
"OPERATOR_UNSPECIFIED",
1667-
"AND"
1662+
"AND",
1663+
"OR"
16681664
],
16691665
"enumDescriptions": [
16701666
"Unspecified. This value must not be used.",
1671-
"Documents are required to satisfy all of the combined filters."
1667+
"Documents are required to satisfy all of the combined filters.",
1668+
"Documents are required to satisfy at least one of the combined filters."
16721669
],
16731670
"type": "string"
16741671
}
@@ -3118,7 +3115,7 @@
31183115
"id": "RunAggregationQueryResponse",
31193116
"properties": {
31203117
"readTime": {
3121-
"description": "The time at which the aggregate value is valid for.",
3118+
"description": "The time at which the aggregate result was computed. This is always monotonically increasing; in this case, the previous AggregationResult in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `result` will be sent, and this represents the time at which the query was run.",
31223119
"format": "google-datetime",
31233120
"type": "string"
31243121
},
@@ -3268,7 +3265,7 @@
32683265
},
32693266
"select": {
32703267
"$ref": "Projection",
3271-
"description": "The projection to return."
3268+
"description": "Optional sub-set of the fields to return. This acts as a DocumentMask over the documents returned from a query. When not set, assumes that the caller wants all fields returned."
32723269
},
32733270
"startAt": {
32743271
"$ref": "Cursor",

googleapiclient/discovery_cache/documents/firestore.v1beta1.json

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -592,7 +592,7 @@
592592
]
593593
},
594594
"listen": {
595-
"description": "Listens to changes. This method is only available via the gRPC API (not REST).",
595+
"description": "Listens to changes. This method is only available via gRPC or WebChannel (not REST).",
596596
"flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:listen",
597597
"httpMethod": "POST",
598598
"id": "firestore.projects.databases.documents.listen",
@@ -789,7 +789,7 @@
789789
]
790790
},
791791
"write": {
792-
"description": "Streams batches of document updates and deletes, in order. This method is only available via the gRPC API (not REST).",
792+
"description": "Streams batches of document updates and deletes, in order. This method is only available via gRPC or WebChannel (not REST).",
793793
"flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:write",
794794
"httpMethod": "POST",
795795
"id": "firestore.projects.databases.documents.write",
@@ -950,7 +950,7 @@
950950
}
951951
}
952952
},
953-
"revision": "20230214",
953+
"revision": "20230228",
954954
"rootUrl": "https://firestore.googleapis.com/",
955955
"schemas": {
956956
"Aggregation": {
@@ -1186,11 +1186,13 @@
11861186
"description": "The operator for combining multiple filters.",
11871187
"enum": [
11881188
"OPERATOR_UNSPECIFIED",
1189-
"AND"
1189+
"AND",
1190+
"OR"
11901191
],
11911192
"enumDescriptions": [
11921193
"Unspecified. This value must not be used.",
1193-
"Documents are required to satisfy all of the combined filters."
1194+
"Documents are required to satisfy all of the combined filters.",
1195+
"Documents are required to satisfy at least one of the combined filters."
11941196
],
11951197
"type": "string"
11961198
}
@@ -2194,7 +2196,7 @@
21942196
"id": "RunAggregationQueryResponse",
21952197
"properties": {
21962198
"readTime": {
2197-
"description": "The time at which the aggregate value is valid for.",
2199+
"description": "The time at which the aggregate result was computed. This is always monotonically increasing; in this case, the previous AggregationResult in the result stream are guaranteed not to have changed between their `read_time` and this one. If the query returns no results, a response with `read_time` and no `result` will be sent, and this represents the time at which the query was run.",
21982200
"format": "google-datetime",
21992201
"type": "string"
22002202
},
@@ -2344,7 +2346,7 @@
23442346
},
23452347
"select": {
23462348
"$ref": "Projection",
2347-
"description": "The projection to return."
2349+
"description": "Optional sub-set of the fields to return. This acts as a DocumentMask over the documents returned from a query. When not set, assumes that the caller wants all fields returned."
23482350
},
23492351
"startAt": {
23502352
"$ref": "Cursor",

googleapiclient/discovery_cache/documents/firestore.v1beta2.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,7 @@
415415
}
416416
}
417417
},
418-
"revision": "20230214",
418+
"revision": "20230228",
419419
"rootUrl": "https://firestore.googleapis.com/",
420420
"schemas": {
421421
"Empty": {

0 commit comments

Comments
 (0)