From 89b34a91c7b56b03d59648bb582d3db1c5e06a4a Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Dec 2022 07:08:01 +0000 Subject: [PATCH] feat(firestore): update the api #### firestore:v1 The following keys were deleted: - schemas.GoogleFirestoreAdminV1ExportDocumentsRequest.properties.namespaceIds (Total Keys: 2) - schemas.GoogleFirestoreAdminV1ImportDocumentsRequest.properties.namespaceIds (Total Keys: 2) The following keys were added: - resources.projects.resources.databases.methods.delete (Total Keys: 15) --- ...store_v1.projects.databases.documents.html | 32 +++---- docs/dyn/firestore_v1.projects.databases.html | 47 ++++++++-- ..._v1beta1.projects.databases.documents.html | 32 +++---- .../documents/firestore.v1.json | 87 ++++++++++++------- .../documents/firestore.v1beta1.json | 32 +++---- .../documents/firestore.v1beta2.json | 2 +- 6 files changed, 147 insertions(+), 85 deletions(-) diff --git a/docs/dyn/firestore_v1.projects.databases.documents.html b/docs/dyn/firestore_v1.projects.databases.documents.html index b63abfbebc0..59b6a8ec429 100644 --- a/docs/dyn/firestore_v1.projects.databases.documents.html +++ b/docs/dyn/firestore_v1.projects.databases.documents.html @@ -990,14 +990,14 @@

Method Details

Args: parent: string, 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` (required) - collectionId: string, Required. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. (required) + collectionId: string, 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`. (required) mask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated) - orderBy: string, The order to sort results by. For example: `priority desc, name`. - pageSize: integer, The maximum number of documents to return. - pageToken: string, The `next_page_token` value returned from a previous List request, if any. - readTime: string, Reads documents as they were at the given time. This may not be older than 270 seconds. - showMissing: boolean, 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`. - transaction: string, Reads documents in a transaction. + orderBy: string, 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`. + pageSize: integer, Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value. + pageToken: string, 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. + readTime: string, Perform the read at the provided time. This may not be older than 270 seconds. + showMissing: boolean, 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`. + transaction: string, Perform the read as part of an already active transaction. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1040,7 +1040,7 @@

Method Details

"updateTime": "A String", # Output only. The time at which the document was last changed. This value is initially set to the `create_time` then increases monotonically with each change to the document. It can also be compared to values from other documents and the `read_time` of a query. }, ], - "nextPageToken": "A String", # The next page token. + "nextPageToken": "A String", # A token to retrieve the next page of documents. If this field is omitted, there are no subsequent pages. } @@ -1095,14 +1095,14 @@

Method Details

Args: parent: string, 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` (required) - collectionId: string, Required. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. (required) + collectionId: string, 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`. (required) mask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated) - orderBy: string, The order to sort results by. For example: `priority desc, name`. - pageSize: integer, The maximum number of documents to return. - pageToken: string, The `next_page_token` value returned from a previous List request, if any. - readTime: string, Reads documents as they were at the given time. This may not be older than 270 seconds. - showMissing: boolean, 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`. - transaction: string, Reads documents in a transaction. + orderBy: string, 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`. + pageSize: integer, Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value. + pageToken: string, 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. + readTime: string, Perform the read at the provided time. This may not be older than 270 seconds. + showMissing: boolean, 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`. + transaction: string, Perform the read as part of an already active transaction. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1145,7 +1145,7 @@

Method Details

"updateTime": "A String", # Output only. The time at which the document was last changed. This value is initially set to the `create_time` then increases monotonically with each change to the document. It can also be compared to values from other documents and the `read_time` of a query. }, ], - "nextPageToken": "A String", # The next page token. + "nextPageToken": "A String", # A token to retrieve the next page of documents. If this field is omitted, there are no subsequent pages. } diff --git a/docs/dyn/firestore_v1.projects.databases.html b/docs/dyn/firestore_v1.projects.databases.html index 03d0826f238..7e85347a41e 100644 --- a/docs/dyn/firestore_v1.projects.databases.html +++ b/docs/dyn/firestore_v1.projects.databases.html @@ -95,6 +95,9 @@

Instance Methods

create(parent, body=None, databaseId=None, x__xgafv=None)

Create a database.

+

+ delete(name, allowMissing=None, etag=None, validateOnly=None, x__xgafv=None)

+

Deletes a database.

exportDocuments(name, body=None, x__xgafv=None)

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

@@ -165,6 +168,44 @@

Method Details

} +
+ delete(name, allowMissing=None, etag=None, validateOnly=None, x__xgafv=None) + 
Deletes a database.
+
+Args:
+  name: string, Required. A name of the form `projects/{project_id}/databases/{database_id}` (required)
+  allowMissing: boolean, If set to true and the Database is not found, the request will succeed but no action will be taken.
+  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.
+  validateOnly: boolean, If set, validate the request and preview the response, but do not actually delete the database.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
exportDocuments(name, body=None, x__xgafv=None) 
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
@@ -178,9 +219,6 @@ 
Method Details

   "collectionIds": [ # Which collection ids to export. Unspecified means all collections.
     "A String",
   ],
-  "namespaceIds": [ # 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.
-    "A String",
-  ],
   "outputUriPrefix": "A String", # 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.
 }
 
@@ -252,9 +290,6 @@ 
Method Details

     "A String",
   ],
   "inputUriPrefix": "A String", # 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.
-  "namespaceIds": [ # 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.
-    "A String",
-  ],
 }
 
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/firestore_v1beta1.projects.databases.documents.html b/docs/dyn/firestore_v1beta1.projects.databases.documents.html
index 1ad60465739..b595ddaa386 100644
--- a/docs/dyn/firestore_v1beta1.projects.databases.documents.html
+++ b/docs/dyn/firestore_v1beta1.projects.databases.documents.html
@@ -990,14 +990,14 @@ 
Method Details

 
 Args:
   parent: string, 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` (required)
-  collectionId: string, Required. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. (required)
+  collectionId: string, 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`. (required)
   mask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated)
-  orderBy: string, The order to sort results by. For example: `priority desc, name`.
-  pageSize: integer, The maximum number of documents to return.
-  pageToken: string, The `next_page_token` value returned from a previous List request, if any.
-  readTime: string, Reads documents as they were at the given time. This may not be older than 270 seconds.
-  showMissing: boolean, 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`.
-  transaction: string, Reads documents in a transaction.
+  orderBy: string, 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`.
+  pageSize: integer, Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value.
+  pageToken: string, 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.
+  readTime: string, Perform the read at the provided time. This may not be older than 270 seconds.
+  showMissing: boolean, 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`.
+  transaction: string, Perform the read as part of an already active transaction.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -1040,7 +1040,7 @@ 
Method Details

       "updateTime": "A String", # Output only. The time at which the document was last changed. This value is initially set to the `create_time` then increases monotonically with each change to the document. It can also be compared to values from other documents and the `read_time` of a query.
     },
   ],
-  "nextPageToken": "A String", # The next page token.
+  "nextPageToken": "A String", # A token to retrieve the next page of documents. If this field is omitted, there are no subsequent pages.
 }
@@ -1095,14 +1095,14 @@

Method Details

Args: parent: string, 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` (required) - collectionId: string, Required. The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`. (required) + collectionId: string, 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`. (required) mask_fieldPaths: string, The list of field paths in the mask. See Document.fields for a field path syntax reference. (repeated) - orderBy: string, The order to sort results by. For example: `priority desc, name`. - pageSize: integer, The maximum number of documents to return. - pageToken: string, The `next_page_token` value returned from a previous List request, if any. - readTime: string, Reads documents as they were at the given time. This may not be older than 270 seconds. - showMissing: boolean, 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`. - transaction: string, Reads documents in a transaction. + orderBy: string, 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`. + pageSize: integer, Optional. The maximum number of documents to return in a single response. Firestore may return fewer than this value. + pageToken: string, 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. + readTime: string, Perform the read at the provided time. This may not be older than 270 seconds. + showMissing: boolean, 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`. + transaction: string, Perform the read as part of an already active transaction. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -1145,7 +1145,7 @@

Method Details

"updateTime": "A String", # Output only. The time at which the document was last changed. This value is initially set to the `create_time` then increases monotonically with each change to the document. It can also be compared to values from other documents and the `read_time` of a query. }, ], - "nextPageToken": "A String", # The next page token. + "nextPageToken": "A String", # A token to retrieve the next page of documents. If this field is omitted, there are no subsequent pages. } diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json index a0168b3f989..625e2f8c1c8 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1.json @@ -146,6 +146,47 @@ "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" + }, + "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", @@ -788,7 +829,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" @@ -800,18 +841,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" }, @@ -823,18 +864,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" @@ -889,7 +930,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" @@ -901,18 +942,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" }, @@ -924,18 +965,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" @@ -1382,7 +1423,7 @@ } } }, - "revision": "20221130", + "revision": "20221210", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2088,13 +2129,6 @@ }, "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" @@ -2270,13 +2304,6 @@ "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" @@ -2735,7 +2762,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" } }, diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json index 7c7ca494a44..8ec326b4c7a 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json @@ -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" @@ -530,7 +530,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" @@ -542,18 +542,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" }, @@ -565,18 +565,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" @@ -950,7 +950,7 @@ } } }, - "revision": "20221130", + "revision": "20221210", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -1940,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" } }, diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta2.json b/googleapiclient/discovery_cache/documents/firestore.v1beta2.json index 6401a362380..44231780150 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1beta2.json @@ -415,7 +415,7 @@ } } }, - "revision": "20221130", + "revision": "20221210", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Empty": {