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
"updateTime": "A String", # 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.
142
142
}
143
143
144
-
databaseId: string, 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.
144
+
databaseId: string, 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)".
name: string, Required. A name of the form `projects/{project_id}/databases/{database_id}` (required)
180
180
allowMissing: boolean, If set to true and the Database is not found, the request will succeed but no action will be taken.
181
181
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.
183
182
validateOnly: boolean, If set, validate the request and preview the response, but do not actually delete the database.
<pclass="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>
<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).
1183
1183
1184
1184
Args:
1185
1185
database: string, Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. (required)
@@ -1242,7 +1242,7 @@ <h3>Method Details</h3>
1242
1242
},
1243
1243
},
1244
1244
],
1245
-
"select": { # The projection of document's fields to return. # The projection to return.
1245
+
"select": { # The projection of document'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.
1246
1246
"fields": [ # The fields to return. If empty, all fields are returned. To only return the name of the document, use `['__name__']`.
1247
1247
{ # A reference to a field in a document, ex: `stats.operations`.
1248
1248
"fieldPath": "A String", # The relative path of the document being referenced. Requires: * Conform to document field name limitations.
@@ -1480,7 +1480,7 @@ <h3>Method Details</h3>
1480
1480
},
1481
1481
},
1482
1482
],
1483
-
"select": { # The projection of document's fields to return. # The projection to return.
1483
+
"select": { # The projection of document'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.
1484
1484
"fields": [ # The fields to return. If empty, all fields are returned. To only return the name of the document, use `['__name__']`.
1485
1485
{ # A reference to a field in a document, ex: `stats.operations`.
1486
1486
"fieldPath": "A String", # The relative path of the document being referenced. Requires: * Conform to document field name limitations.
@@ -1806,7 +1806,7 @@ <h3>Method Details</h3>
1806
1806
},
1807
1807
},
1808
1808
],
1809
-
"select": { # The projection of document's fields to return. # The projection to return.
1809
+
"select": { # The projection of document'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.
1810
1810
"fields": [ # The fields to return. If empty, all fields are returned. To only return the name of the document, use `['__name__']`.
1811
1811
{ # A reference to a field in a document, ex: `stats.operations`.
1812
1812
"fieldPath": "A String", # The relative path of the document being referenced. Requires: * Conform to document field name limitations.
@@ -1900,7 +1900,7 @@ <h3>Method Details</h3>
1900
1900
An object of the form:
1901
1901
1902
1902
{ # The response for Firestore.RunAggregationQuery.
1903
-
"readTime": "A String", # The time at which the aggregate value is valid for.
1903
+
"readTime": "A String", # 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.
1904
1904
"result": { # 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.
1905
1905
"aggregateFields": { # 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.
1906
1906
"a_key": { # A message that can hold any of the supported value types.
@@ -1998,7 +1998,7 @@ <h3>Method Details</h3>
1998
1998
},
1999
1999
},
2000
2000
],
2001
-
"select": { # The projection of document's fields to return. # The projection to return.
2001
+
"select": { # The projection of document'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.
2002
2002
"fields": [ # The fields to return. If empty, all fields are returned. To only return the name of the document, use `['__name__']`.
2003
2003
{ # A reference to a field in a document, ex: `stats.operations`.
2004
2004
"fieldPath": "A String", # The relative path of the document being referenced. Requires: * Conform to document field name limitations.
<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).
2135
2135
2136
2136
Args:
2137
2137
database: string, Required. The database name. In the format: `projects/{project_id}/databases/{database_id}`. This is only required in the first message. (required)
Copy file name to clipboardExpand all lines: googleapiclient/discovery_cache/documents/firestore.v1.json
+10-13Lines changed: 10 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -122,7 +122,7 @@
122
122
],
123
123
"parameters": {
124
124
"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)\".",
126
126
"location": "query",
127
127
"type": "string"
128
128
},
@@ -165,11 +165,6 @@
165
165
"location": "query",
166
166
"type": "string"
167
167
},
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
-
},
173
168
"name": {
174
169
"description": "Required. A name of the form `projects/{project_id}/databases/{database_id}`",
175
170
"location": "path",
@@ -997,7 +992,7 @@
997
992
]
998
993
},
999
994
"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).",
"description": "The operator for combining multiple filters.",
1665
1660
"enum": [
1666
1661
"OPERATOR_UNSPECIFIED",
1667
-
"AND"
1662
+
"AND",
1663
+
"OR"
1668
1664
],
1669
1665
"enumDescriptions": [
1670
1666
"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."
1672
1669
],
1673
1670
"type": "string"
1674
1671
}
@@ -3118,7 +3115,7 @@
3118
3115
"id": "RunAggregationQueryResponse",
3119
3116
"properties": {
3120
3117
"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.",
3122
3119
"format": "google-datetime",
3123
3120
"type": "string"
3124
3121
},
@@ -3268,7 +3265,7 @@
3268
3265
},
3269
3266
"select": {
3270
3267
"$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."
"description": "The operator for combining multiple filters.",
1187
1187
"enum": [
1188
1188
"OPERATOR_UNSPECIFIED",
1189
-
"AND"
1189
+
"AND",
1190
+
"OR"
1190
1191
],
1191
1192
"enumDescriptions": [
1192
1193
"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."
1194
1196
],
1195
1197
"type": "string"
1196
1198
}
@@ -2194,7 +2196,7 @@
2194
2196
"id": "RunAggregationQueryResponse",
2195
2197
"properties": {
2196
2198
"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.",
2198
2200
"format": "google-datetime",
2199
2201
"type": "string"
2200
2202
},
@@ -2344,7 +2346,7 @@
2344
2346
},
2345
2347
"select": {
2346
2348
"$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."
0 commit comments