mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-02-23 15:49:49 +01:00
update dependencies
This commit is contained in:
Sebastian Thiel
@@ -429,7 +429,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"collectionId": {
|
||||
"description": "Required. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`.",
|
||||
"description": "Optional. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. This is optional, and when not provided, Firestore will list documents from all collections under the provided `parent`.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
@@ -441,18 +441,18 @@
|
||||
"type": "string"
|
||||
},
|
||||
"orderBy": {
|
||||
"description": "The order to sort results by. For example: `priority desc, name`.",
|
||||
"description": "Optional. The optional ordering of the documents to return. For example: `priority desc, __name__ desc`. This mirrors the `ORDER BY` used in Firestore queries but in a string representation. When absent, documents are ordered based on `__name__ ASC`.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "The maximum number of documents to return.",
|
||||
"description": "Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "The `next_page_token` value returned from a previous List request, if any.",
|
||||
"description": "Optional. A page token, received from a previous `ListDocuments` response. Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of `page_size`) must match the values set in the request that generated the page token.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -464,18 +464,18 @@
|
||||
"type": "string"
|
||||
},
|
||||
"readTime": {
|
||||
"description": "Reads documents as they were at the given time. This may not be older than 270 seconds.",
|
||||
"description": "Perform the read at the provided time. This may not be older than 270 seconds.",
|
||||
"format": "google-datetime",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"showMissing": {
|
||||
"description": "If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document.create_time, or Document.update_time set. Requests with `show_missing` may not specify `where` or `order_by`.",
|
||||
"description": "If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`.",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
},
|
||||
"transaction": {
|
||||
"description": "Reads documents in a transaction.",
|
||||
"description": "Perform the read as part of an already active transaction.",
|
||||
"format": "byte",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
@@ -519,6 +519,78 @@
|
||||
"https://www.googleapis.com/auth/datastore"
|
||||
]
|
||||
},
|
||||
"listDocuments": {
|
||||
"description": "Lists documents.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{collectionId}",
|
||||
"httpMethod": "GET",
|
||||
"id": "firestore.projects.databases.documents.listDocuments",
|
||||
"parameterOrder": [
|
||||
"parent",
|
||||
"collectionId"
|
||||
],
|
||||
"parameters": {
|
||||
"collectionId": {
|
||||
"description": "Optional. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. This is optional, and when not provided, Firestore will list documents from all collections under the provided `parent`.",
|
||||
"location": "path",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"mask.fieldPaths": {
|
||||
"description": "The list of field paths in the mask. See Document.fields for a field path syntax reference.",
|
||||
"location": "query",
|
||||
"repeated": true,
|
||||
"type": "string"
|
||||
},
|
||||
"orderBy": {
|
||||
"description": "Optional. The optional ordering of the documents to return. For example: `priority desc, __name__ desc`. This mirrors the `ORDER BY` used in Firestore queries but in a string representation. When absent, documents are ordered based on `__name__ ASC`.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"pageSize": {
|
||||
"description": "Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value.",
|
||||
"format": "int32",
|
||||
"location": "query",
|
||||
"type": "integer"
|
||||
},
|
||||
"pageToken": {
|
||||
"description": "Optional. A page token, received from a previous `ListDocuments` response. Provide this to retrieve the subsequent page. When paginating, all other parameters (with the exception of `page_size`) must match the values set in the request that generated the page token.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/databases/[^/]+/documents$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"readTime": {
|
||||
"description": "Perform the read at the provided time. This may not be older than 270 seconds.",
|
||||
"format": "google-datetime",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"showMissing": {
|
||||
"description": "If the list should show missing documents. A document is missing if it does not exist, but there are sub-documents nested underneath it. When true, such missing documents will be returned with a key but will not have fields, `create_time`, or `update_time` set. Requests with `show_missing` may not specify `where` or `order_by`.",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
},
|
||||
"transaction": {
|
||||
"description": "Perform the read as part of an already active transaction.",
|
||||
"format": "byte",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+parent}/{collectionId}",
|
||||
"response": {
|
||||
"$ref": "ListDocumentsResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/datastore"
|
||||
]
|
||||
},
|
||||
"listen": {
|
||||
"description": "Listens to changes.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:listen",
|
||||
@@ -658,6 +730,35 @@
|
||||
"https://www.googleapis.com/auth/datastore"
|
||||
]
|
||||
},
|
||||
"runAggregationQuery": {
|
||||
"description": "Runs an aggregation query. Rather than producing Document results like Firestore.RunQuery, this API allows running an aggregation to produce a series of AggregationResult server-side. High-Level Example: ``` -- Return the number of documents in table given a filter. SELECT COUNT(*) FROM ( SELECT * FROM k where a = true ); ```",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:runAggregationQuery",
|
||||
"httpMethod": "POST",
|
||||
"id": "firestore.projects.databases.documents.runAggregationQuery",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"parent": {
|
||||
"description": "Required. The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.*$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1beta1/{+parent}:runAggregationQuery",
|
||||
"request": {
|
||||
"$ref": "RunAggregationQueryRequest"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "RunAggregationQueryResponse"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/datastore"
|
||||
]
|
||||
},
|
||||
"runQuery": {
|
||||
"description": "Runs a query.",
|
||||
"flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:runQuery",
|
||||
@@ -849,9 +950,38 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"revision": "20220221",
|
||||
"revision": "20230118",
|
||||
"rootUrl": "https://firestore.googleapis.com/",
|
||||
"schemas": {
|
||||
"Aggregation": {
|
||||
"description": "Defines a aggregation that produces a single result.",
|
||||
"id": "Aggregation",
|
||||
"properties": {
|
||||
"alias": {
|
||||
"description": "Optional. Optional name of the field to store the result of the aggregation into. If not provided, Firestore will pick a default name following the format `field_`. For example: ``` AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2), COUNT_UP_TO(3) AS count_up_to_3, COUNT_UP_TO(4) OVER ( ... ); ``` becomes: ``` AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2) AS field_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT_UP_TO(4) AS field_2 OVER ( ... ); ``` Requires: * Must be unique across all aggregation aliases. * Conform to document field name limitations.",
|
||||
"type": "string"
|
||||
},
|
||||
"count": {
|
||||
"$ref": "Count",
|
||||
"description": "Count aggregator."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"AggregationResult": {
|
||||
"description": "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.",
|
||||
"id": "AggregationResult",
|
||||
"properties": {
|
||||
"aggregateFields": {
|
||||
"additionalProperties": {
|
||||
"$ref": "Value"
|
||||
},
|
||||
"description": "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.",
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"ArrayValue": {
|
||||
"description": "An array value.",
|
||||
"id": "ArrayValue",
|
||||
@@ -1046,7 +1176,7 @@
|
||||
"id": "CompositeFilter",
|
||||
"properties": {
|
||||
"filters": {
|
||||
"description": "The list of filters to combine. Must contain at least one filter.",
|
||||
"description": "The list of filters to combine. Requires: * At least one filter is present.",
|
||||
"items": {
|
||||
"$ref": "Filter"
|
||||
},
|
||||
@@ -1060,13 +1190,25 @@
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Unspecified. This value must not be used.",
|
||||
"The results are required to satisfy each of the combined filters."
|
||||
"Documents are required to satisfy all of the combined filters."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Count": {
|
||||
"description": "Count of documents that match the query. The `COUNT(*)` aggregation function operates on the entire document so it does not require a field reference.",
|
||||
"id": "Count",
|
||||
"properties": {
|
||||
"upTo": {
|
||||
"description": "Optional. Optional constraint on the maximum number of documents to count. This provides a way to set an upper bound on the number of documents to scan, limiting latency and cost. Unspecified is interpreted as no bound. High-Level Example: ``` AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k ); ``` Requires: * Must be greater than zero when present.",
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"Cursor": {
|
||||
"description": "A position in a query result set.",
|
||||
"id": "Cursor",
|
||||
@@ -1235,7 +1377,7 @@
|
||||
"type": "object"
|
||||
},
|
||||
"Empty": {
|
||||
"description": "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); } The JSON representation for `Empty` is empty JSON object `{}`.",
|
||||
"description": "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); }",
|
||||
"id": "Empty",
|
||||
"properties": {},
|
||||
"type": "object"
|
||||
@@ -1303,10 +1445,11 @@
|
||||
"type": "object"
|
||||
},
|
||||
"FieldReference": {
|
||||
"description": "A reference to a field, such as `max(messages.time) as max_time`.",
|
||||
"description": "A reference to a field in a document, ex: `stats.operations`.",
|
||||
"id": "FieldReference",
|
||||
"properties": {
|
||||
"fieldPath": {
|
||||
"description": "The relative path of the document being referenced. Requires: * Conform to document field name limitations.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -1758,6 +1901,11 @@
|
||||
"pageToken": {
|
||||
"description": "A page token. Must be a value from ListCollectionIdsResponse.",
|
||||
"type": "string"
|
||||
},
|
||||
"readTime": {
|
||||
"description": "Reads documents as they were at the given time. This may not be older than 270 seconds.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -1792,7 +1940,7 @@
|
||||
"type": "array"
|
||||
},
|
||||
"nextPageToken": {
|
||||
"description": "The next page token.",
|
||||
"description": "A token to retrieve the next page of documents. If this field is omitted, there are no subsequent pages.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
@@ -1905,6 +2053,11 @@
|
||||
"format": "int64",
|
||||
"type": "string"
|
||||
},
|
||||
"readTime": {
|
||||
"description": "Reads documents as they were at the given time. This may not be older than 270 seconds.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"structuredQuery": {
|
||||
"$ref": "StructuredQuery",
|
||||
"description": "A structured query. Query must specify collection with all descendants and be ordered by name ascending. Other filters, order bys, limits, offsets, and start/end cursors are not supported."
|
||||
@@ -2011,6 +2164,52 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"RunAggregationQueryRequest": {
|
||||
"description": "The request for Firestore.RunAggregationQuery.",
|
||||
"id": "RunAggregationQueryRequest",
|
||||
"properties": {
|
||||
"newTransaction": {
|
||||
"$ref": "TransactionOptions",
|
||||
"description": "Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream."
|
||||
},
|
||||
"readTime": {
|
||||
"description": "Executes the query at the given timestamp. Requires: * Cannot be more than 270 seconds in the past.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"structuredAggregationQuery": {
|
||||
"$ref": "StructuredAggregationQuery",
|
||||
"description": "An aggregation query."
|
||||
},
|
||||
"transaction": {
|
||||
"description": "Run the aggregation within an already active transaction. The value here is the opaque transaction ID to execute the query in.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"RunAggregationQueryResponse": {
|
||||
"description": "The response for Firestore.RunAggregationQuery.",
|
||||
"id": "RunAggregationQueryResponse",
|
||||
"properties": {
|
||||
"readTime": {
|
||||
"description": "The time at which the aggregate value is valid for.",
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"result": {
|
||||
"$ref": "AggregationResult",
|
||||
"description": "A single aggregation result. Not present when reporting partial progress."
|
||||
},
|
||||
"transaction": {
|
||||
"description": "The transaction that was started as part of this request. Only present on the first response when the request requested to start a new transaction.",
|
||||
"format": "byte",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"RunQueryRequest": {
|
||||
"description": "The request for Firestore.RunQuery.",
|
||||
"id": "RunQueryRequest",
|
||||
@@ -2044,6 +2243,10 @@
|
||||
"$ref": "Document",
|
||||
"description": "A query result, not set when reporting partial progress."
|
||||
},
|
||||
"done": {
|
||||
"description": "If present, Firestore has completely finished the request and no more documents will be returned.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"readTime": {
|
||||
"description": "The time at which the document was read. This may be monotonically increasing; in this case, the previous documents 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 `document` will be sent, and this represents the time at which the query was run.",
|
||||
"format": "google-datetime",
|
||||
@@ -2089,13 +2292,31 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"StructuredAggregationQuery": {
|
||||
"description": "Firestore query for running an aggregation over a StructuredQuery.",
|
||||
"id": "StructuredAggregationQuery",
|
||||
"properties": {
|
||||
"aggregations": {
|
||||
"description": "Optional. Series of aggregations to apply over the results of the `structured_query`. Requires: * A minimum of one and maximum of five aggregations per query.",
|
||||
"items": {
|
||||
"$ref": "Aggregation"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"structuredQuery": {
|
||||
"$ref": "StructuredQuery",
|
||||
"description": "Nested structured query."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"StructuredQuery": {
|
||||
"description": "A Firestore query.",
|
||||
"id": "StructuredQuery",
|
||||
"properties": {
|
||||
"endAt": {
|
||||
"$ref": "Cursor",
|
||||
"description": "A end point for the query results."
|
||||
"description": "A potential prefix of a position in the result set to end the query at. This is similar to `START_AT` but with it controlling the end position rather than the start position. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause."
|
||||
},
|
||||
"from": {
|
||||
"description": "The collections to query.",
|
||||
@@ -2105,17 +2326,17 @@
|
||||
"type": "array"
|
||||
},
|
||||
"limit": {
|
||||
"description": "The maximum number of results to return. Applies after all other constraints. Must be >= 0 if specified.",
|
||||
"description": "The maximum number of results to return. Applies after all other constraints. Requires: * The value must be greater than or equal to zero if specified.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"offset": {
|
||||
"description": "The number of results to skip. Applies before limit, but after all other constraints. Must be >= 0 if specified.",
|
||||
"description": "The number of documents to skip before returning the first result. This applies after the constraints specified by the `WHERE`, `START AT`, & `END AT` but before the `LIMIT` clause. Requires: * The value must be greater than or equal to zero if specified.",
|
||||
"format": "int32",
|
||||
"type": "integer"
|
||||
},
|
||||
"orderBy": {
|
||||
"description": "The order to apply to the query results. Firestore guarantees a stable ordering through the following rules: * Any field required to appear in `order_by`, that is not already specified in `order_by`, is appended to the order in field name order by default. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `SELECT * FROM Foo ORDER BY A` becomes `SELECT * FROM Foo ORDER BY A, __name__` * `SELECT * FROM Foo ORDER BY A DESC` becomes `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC` * `SELECT * FROM Foo WHERE A > 1` becomes `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__`",
|
||||
"description": "The order to apply to the query results. Firestore allows callers to provide a full ordering, a partial ordering, or no ordering at all. In all cases, Firestore guarantees a stable ordering through the following rules: * The `order_by` is required to reference all fields used with an inequality filter. * All fields that are required to be in the `order_by` but are not already present are appended in lexicographical ordering of the field name. * If an order on `__name__` is not specified, it is appended by default. Fields are appended with the same sort direction as the last order specified, or 'ASCENDING' if no order was specified. For example: * `ORDER BY a` becomes `ORDER BY a ASC, __name__ ASC` * `ORDER BY a DESC` becomes `ORDER BY a DESC, __name__ DESC` * `WHERE a > 1` becomes `WHERE a > 1 ORDER BY a ASC, __name__ ASC` * `WHERE __name__ > ... AND a > 1` becomes `WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC`",
|
||||
"items": {
|
||||
"$ref": "Order"
|
||||
},
|
||||
@@ -2127,7 +2348,7 @@
|
||||
},
|
||||
"startAt": {
|
||||
"$ref": "Cursor",
|
||||
"description": "A starting point for the query results."
|
||||
"description": "A potential prefix of a position in the result set to start the query at. The ordering of the result set is based on the `ORDER BY` clause of the original query. ``` SELECT * FROM k WHERE a = 1 AND b > 2 ORDER BY b ASC, __name__ ASC; ``` This query's results are ordered by `(b ASC, __name__ ASC)`. Cursors can reference either the full ordering or a prefix of the location, though it cannot reference more fields than what are in the provided `ORDER BY`. Continuing off the example above, attaching the following start cursors will have varying impact: - `START BEFORE (2, /k/123)`: start the query right before `a = 1 AND b > 2 AND __name__ > /k/123`. - `START AFTER (10)`: start the query right after `a = 1 AND b > 10`. Unlike `OFFSET` which requires scanning over the first N results to skip, a start cursor allows the query to begin at a logical position. This position is not required to match an actual result, it will scan forward from this position to find the next document. Requires: * The number of values cannot be greater than the number of fields specified in the `ORDER BY` clause."
|
||||
},
|
||||
"where": {
|
||||
"$ref": "Filter",
|
||||
|
||||
Reference in New Issue
Block a user