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
@@ -112,6 +112,86 @@
|
||||
"resources": {
|
||||
"databases": {
|
||||
"methods": {
|
||||
"create": {
|
||||
"description": "Create a database.",
|
||||
"flatPath": "v1/projects/{projectsId}/databases",
|
||||
"httpMethod": "POST",
|
||||
"id": "firestore.projects.databases.create",
|
||||
"parameterOrder": [
|
||||
"parent"
|
||||
],
|
||||
"parameters": {
|
||||
"databaseId": {
|
||||
"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.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"parent": {
|
||||
"description": "Required. A parent name of the form `projects/{project_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+parent}/databases",
|
||||
"request": {
|
||||
"$ref": "GoogleFirestoreAdminV1Database"
|
||||
},
|
||||
"response": {
|
||||
"$ref": "GoogleLongrunningOperation"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/datastore"
|
||||
]
|
||||
},
|
||||
"delete": {
|
||||
"description": "Deletes a database.",
|
||||
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}",
|
||||
"httpMethod": "DELETE",
|
||||
"id": "firestore.projects.databases.delete",
|
||||
"parameterOrder": [
|
||||
"name"
|
||||
],
|
||||
"parameters": {
|
||||
"allowMissing": {
|
||||
"description": "If set to true and the Database is not found, the request will succeed but no action will be taken.",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
},
|
||||
"etag": {
|
||||
"description": "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.",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
"freeId": {
|
||||
"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.",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
},
|
||||
"name": {
|
||||
"description": "Required. A name of the form `projects/{project_id}/databases/{database_id}`",
|
||||
"location": "path",
|
||||
"pattern": "^projects/[^/]+/databases/[^/]+$",
|
||||
"required": true,
|
||||
"type": "string"
|
||||
},
|
||||
"validateOnly": {
|
||||
"description": "If set, validate the request and preview the response, but do not actually delete the database.",
|
||||
"location": "query",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"path": "v1/{+name}",
|
||||
"response": {
|
||||
"$ref": "GoogleLongrunningOperation"
|
||||
},
|
||||
"scopes": [
|
||||
"https://www.googleapis.com/auth/cloud-platform",
|
||||
"https://www.googleapis.com/auth/datastore"
|
||||
]
|
||||
},
|
||||
"exportDocuments": {
|
||||
"description": "Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage. For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import",
|
||||
"flatPath": "v1/projects/{projectsId}/databases/{databasesId}:exportDocuments",
|
||||
@@ -754,7 +834,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"
|
||||
@@ -766,18 +846,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"
|
||||
},
|
||||
@@ -789,18 +869,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"
|
||||
@@ -844,6 +924,78 @@
|
||||
"https://www.googleapis.com/auth/datastore"
|
||||
]
|
||||
},
|
||||
"listDocuments": {
|
||||
"description": "Lists documents.",
|
||||
"flatPath": "v1/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": "v1/{+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": "v1/projects/{projectsId}/databases/{databasesId}/documents:listen",
|
||||
@@ -983,6 +1135,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": "v1/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": "v1/{+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": "v1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:runQuery",
|
||||
@@ -1210,7 +1391,7 @@
|
||||
],
|
||||
"parameters": {
|
||||
"filter": {
|
||||
"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like \"displayName=tokyo\", and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
|
||||
"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
|
||||
"location": "query",
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1247,9 +1428,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",
|
||||
@@ -1444,7 +1654,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"
|
||||
},
|
||||
@@ -1458,13 +1668,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",
|
||||
@@ -1633,7 +1855,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"
|
||||
@@ -1701,10 +1923,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"
|
||||
}
|
||||
},
|
||||
@@ -1776,6 +1999,20 @@
|
||||
"description": "A Cloud Firestore Database. Currently only one database is allowed per cloud project; this database must have a `database_id` of '(default)'.",
|
||||
"id": "GoogleFirestoreAdminV1Database",
|
||||
"properties": {
|
||||
"appEngineIntegrationMode": {
|
||||
"description": "The App Engine integration mode to use for this database.",
|
||||
"enum": [
|
||||
"APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED",
|
||||
"ENABLED",
|
||||
"DISABLED"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Not used.",
|
||||
"If an App Engine application exists in the same region as this database, App Engine configuration will impact this database. This includes disabling of the application & database, as well as disabling writes to the database.",
|
||||
"Appengine has no affect on the ability of this database to serve requests."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"concurrencyMode": {
|
||||
"description": "The concurrency control mode to use for this database.",
|
||||
"enum": [
|
||||
@@ -1786,9 +2023,9 @@
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"Not used.",
|
||||
"Use optimistic concurrency control by default. This setting is available for Cloud Firestore customers.",
|
||||
"Use pessimistic concurrency control by default. This setting is available for Cloud Firestore customers. This is the default setting for Cloud Firestore.",
|
||||
"Use optimistic concurrency control with entity groups by default. This is the only available setting for Cloud Datastore customers. This is the default setting for Cloud Datastore."
|
||||
"Use optimistic concurrency control by default. This mode is available for Cloud Firestore databases.",
|
||||
"Use pessimistic concurrency control by default. This mode is available for Cloud Firestore databases. This is the default setting for Cloud Firestore.",
|
||||
"Use optimistic concurrency control with entity groups by default. This is the only available mode for Cloud Datastore. This mode is also available for Cloud Firestore with Datastore Mode but is not recommended."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -1796,6 +2033,11 @@
|
||||
"description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.",
|
||||
"type": "string"
|
||||
},
|
||||
"keyPrefix": {
|
||||
"description": "Output only. The key_prefix for this database. This key_prefix is used, in combination with the project id (\"~\") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).",
|
||||
"readOnly": true,
|
||||
"type": "string"
|
||||
},
|
||||
"locationId": {
|
||||
"description": "The location of the database. Available databases are listed at https://cloud.google.com/firestore/docs/locations.",
|
||||
"type": "string"
|
||||
@@ -1837,6 +2079,13 @@
|
||||
"format": "google-datetime",
|
||||
"type": "string"
|
||||
},
|
||||
"namespaceIds": {
|
||||
"description": "Which namespace ids are being exported.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"operationState": {
|
||||
"description": "The state of the export operation.",
|
||||
"enum": [
|
||||
@@ -1862,7 +2111,7 @@
|
||||
"type": "string"
|
||||
},
|
||||
"outputUriPrefix": {
|
||||
"description": "Where the entities are being exported to.",
|
||||
"description": "Where the documents are being exported to.",
|
||||
"type": "string"
|
||||
},
|
||||
"progressBytes": {
|
||||
@@ -1892,6 +2141,13 @@
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"namespaceIds": {
|
||||
"description": "An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"outputUriPrefix": {
|
||||
"description": "The output URI. Currently only supports Google Cloud Storage URIs of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time.",
|
||||
"type": "string"
|
||||
@@ -1921,6 +2177,10 @@
|
||||
"name": {
|
||||
"description": "Required. A field name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` A field path may be a simple field name, e.g. `address` or a path to fields within map_value , e.g. `address.city`, or a special field path. The only valid special field is `*`, which represents any field. Field paths may be quoted using ` (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `\\`address.city\\`` represents a field named `address.city`, not the map key `city` in the field `address`. `\\`*\\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration.",
|
||||
"type": "string"
|
||||
},
|
||||
"ttlConfig": {
|
||||
"$ref": "GoogleFirestoreAdminV1TtlConfig",
|
||||
"description": "The TTL configuration for this `Field`. Setting or unsetting this will enable or disable the TTL for documents that have this `Field`."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -1981,6 +2241,10 @@
|
||||
"Request has finished being cancelled after user called google.longrunning.Operations.CancelOperation."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"ttlConfigDelta": {
|
||||
"$ref": "GoogleFirestoreAdminV1TtlConfigDelta",
|
||||
"description": "Describes the deltas of TTL configuration."
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -2005,6 +2269,13 @@
|
||||
"description": "The location of the documents being imported.",
|
||||
"type": "string"
|
||||
},
|
||||
"namespaceIds": {
|
||||
"description": "Which namespace ids are being imported.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"operationState": {
|
||||
"description": "The state of the import operation.",
|
||||
"enum": [
|
||||
@@ -2059,6 +2330,13 @@
|
||||
"inputUriPrefix": {
|
||||
"description": "Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.",
|
||||
"type": "string"
|
||||
},
|
||||
"namespaceIds": {
|
||||
"description": "An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
@@ -2067,8 +2345,20 @@
|
||||
"description": "Cloud Firestore indexes enable simple and complex queries against documents in a database.",
|
||||
"id": "GoogleFirestoreAdminV1Index",
|
||||
"properties": {
|
||||
"apiScope": {
|
||||
"description": "The API scope supported by this index.",
|
||||
"enum": [
|
||||
"ANY_API",
|
||||
"DATASTORE_MODE_API"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"The index can be used by both Firestore Native and Firestore in Datastore Mode query API. This is the default.",
|
||||
"The index can only be used by the Firestore in Datastore Mode query API."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"fields": {
|
||||
"description": "The fields supported by this index. For composite indexes, this is always 2 or more fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.",
|
||||
"description": "The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field.",
|
||||
"items": {
|
||||
"$ref": "GoogleFirestoreAdminV1IndexField"
|
||||
},
|
||||
@@ -2083,12 +2373,14 @@
|
||||
"enum": [
|
||||
"QUERY_SCOPE_UNSPECIFIED",
|
||||
"COLLECTION",
|
||||
"COLLECTION_GROUP"
|
||||
"COLLECTION_GROUP",
|
||||
"COLLECTION_RECURSIVE"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"The query scope is unspecified. Not a valid option.",
|
||||
"Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the collection id specified by the index.",
|
||||
"Indexes with a collection group query scope specified allow queries against all collections that has the collection id specified by the index."
|
||||
"Indexes with a collection group query scope specified allow queries against all collections that has the collection id specified by the index.",
|
||||
"Include all the collections's ancestor in the index. Only available for Datastore Mode databases."
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -2325,6 +2617,51 @@
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleFirestoreAdminV1TtlConfig": {
|
||||
"description": "The TTL (time-to-live) configuration for documents that have this `Field` set. Storing a timestamp value into a TTL-enabled field will be treated as the document's absolute expiration time. Timestamp values in the past indicate that the document is eligible for immediate expiration. Using any other data type or leaving the field absent will disable expiration for the individual document.",
|
||||
"id": "GoogleFirestoreAdminV1TtlConfig",
|
||||
"properties": {
|
||||
"state": {
|
||||
"description": "Output only. The state of the TTL configuration.",
|
||||
"enum": [
|
||||
"STATE_UNSPECIFIED",
|
||||
"CREATING",
|
||||
"ACTIVE",
|
||||
"NEEDS_REPAIR"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"The state is unspecified or unknown.",
|
||||
"The TTL is being applied. There is an active long-running operation to track the change. Newly written documents will have TTLs applied as requested. Requested TTLs on existing documents are still being processed. When TTLs on all existing documents have been processed, the state will move to 'ACTIVE'.",
|
||||
"The TTL is active for all documents.",
|
||||
"The TTL configuration could not be enabled for all existing documents. Newly written documents will continue to have their TTL applied. The LRO returned when last attempting to enable TTL for this `Field` has failed, and may have more details."
|
||||
],
|
||||
"readOnly": true,
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleFirestoreAdminV1TtlConfigDelta": {
|
||||
"description": "Information about an TTL configuration change.",
|
||||
"id": "GoogleFirestoreAdminV1TtlConfigDelta",
|
||||
"properties": {
|
||||
"changeType": {
|
||||
"description": "Specifies how the TTL configuration is changing.",
|
||||
"enum": [
|
||||
"CHANGE_TYPE_UNSPECIFIED",
|
||||
"ADD",
|
||||
"REMOVE"
|
||||
],
|
||||
"enumDescriptions": [
|
||||
"The type of change is not specified or known.",
|
||||
"The TTL config is being added.",
|
||||
"The TTL config is being removed."
|
||||
],
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"GoogleFirestoreAdminV1UpdateDatabaseMetadata": {
|
||||
"description": "Metadata related to the update database operation.",
|
||||
"id": "GoogleFirestoreAdminV1UpdateDatabaseMetadata",
|
||||
@@ -2419,6 +2756,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"
|
||||
@@ -2453,7 +2795,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"
|
||||
}
|
||||
},
|
||||
@@ -2618,6 +2960,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."
|
||||
@@ -2724,6 +3071,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",
|
||||
@@ -2757,6 +3150,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",
|
||||
@@ -2802,13 +3199,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.",
|
||||
@@ -2818,17 +3233,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"
|
||||
},
|
||||
@@ -2840,7 +3255,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