Skip to content

Commit ae491de

Browse files
feat(firestore): update the api
#### firestore:v1 The following keys were added: - resources.projects.resources.databases.methods.list.parameters.showDeleted (Total Keys: 2) - schemas.GoogleFirestoreAdminV1Database.properties.deleteTime (Total Keys: 3)
1 parent 2a94e44 commit ae491de

File tree

4 files changed

+21
-5
lines changed

4 files changed

+21
-5
lines changed

docs/dyn/firestore_v1.projects.databases.html

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ <h2>Instance Methods</h2>
113113
<code><a href="#importDocuments">importDocuments(name, body=None, x__xgafv=None)</a></code></p>
114114
<p class="firstline">Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.</p>
115115
<p class="toc_element">
116-
<code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
116+
<code><a href="#list">list(parent, showDeleted=None, x__xgafv=None)</a></code></p>
117117
<p class="firstline">List all the databases in the project.</p>
118118
<p class="toc_element">
119119
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
@@ -147,6 +147,7 @@ <h3>Method Details</h3>
147147
&quot;concurrencyMode&quot;: &quot;A String&quot;, # The concurrency control mode to use for this database.
148148
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp at which this database was created. Databases created before 2016 do not populate create_time.
149149
&quot;deleteProtectionState&quot;: &quot;A String&quot;, # State of delete protection for the database.
150+
&quot;deleteTime&quot;: &quot;A String&quot;, # Output only. The timestamp at which this database was soft deleted. Only set if the database has been soft deleted.
150151
&quot;earliestVersionTime&quot;: &quot;A String&quot;, # Output only. The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with `now - version_retention_period`. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.
151152
&quot;etag&quot;: &quot;A String&quot;, # 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.
152153
&quot;keyPrefix&quot;: &quot;A String&quot;, # Output only. The key_prefix for this database. This key_prefix is used, in combination with the project id (&quot;~&quot;) 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).
@@ -299,6 +300,7 @@ <h3>Method Details</h3>
299300
&quot;concurrencyMode&quot;: &quot;A String&quot;, # The concurrency control mode to use for this database.
300301
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp at which this database was created. Databases created before 2016 do not populate create_time.
301302
&quot;deleteProtectionState&quot;: &quot;A String&quot;, # State of delete protection for the database.
303+
&quot;deleteTime&quot;: &quot;A String&quot;, # Output only. The timestamp at which this database was soft deleted. Only set if the database has been soft deleted.
302304
&quot;earliestVersionTime&quot;: &quot;A String&quot;, # Output only. The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with `now - version_retention_period`. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.
303305
&quot;etag&quot;: &quot;A String&quot;, # 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.
304306
&quot;keyPrefix&quot;: &quot;A String&quot;, # Output only. The key_prefix for this database. This key_prefix is used, in combination with the project id (&quot;~&quot;) 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).
@@ -361,11 +363,12 @@ <h3>Method Details</h3>
361363
</div>
362364

363365
<div class="method">
364-
<code class="details" id="list">list(parent, x__xgafv=None)</code>
366+
<code class="details" id="list">list(parent, showDeleted=None, x__xgafv=None)</code>
365367
<pre>List all the databases in the project.
366368

367369
Args:
368370
parent: string, Required. A parent name of the form `projects/{project_id}` (required)
371+
showDeleted: boolean, If true, also returns deleted resources.
369372
x__xgafv: string, V1 error format.
370373
Allowed values
371374
1 - v1 error format
@@ -387,6 +390,7 @@ <h3>Method Details</h3>
387390
&quot;concurrencyMode&quot;: &quot;A String&quot;, # The concurrency control mode to use for this database.
388391
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp at which this database was created. Databases created before 2016 do not populate create_time.
389392
&quot;deleteProtectionState&quot;: &quot;A String&quot;, # State of delete protection for the database.
393+
&quot;deleteTime&quot;: &quot;A String&quot;, # Output only. The timestamp at which this database was soft deleted. Only set if the database has been soft deleted.
390394
&quot;earliestVersionTime&quot;: &quot;A String&quot;, # Output only. The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with `now - version_retention_period`. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.
391395
&quot;etag&quot;: &quot;A String&quot;, # 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.
392396
&quot;keyPrefix&quot;: &quot;A String&quot;, # Output only. The key_prefix for this database. This key_prefix is used, in combination with the project id (&quot;~&quot;) 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).
@@ -425,6 +429,7 @@ <h3>Method Details</h3>
425429
&quot;concurrencyMode&quot;: &quot;A String&quot;, # The concurrency control mode to use for this database.
426430
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The timestamp at which this database was created. Databases created before 2016 do not populate create_time.
427431
&quot;deleteProtectionState&quot;: &quot;A String&quot;, # State of delete protection for the database.
432+
&quot;deleteTime&quot;: &quot;A String&quot;, # Output only. The timestamp at which this database was soft deleted. Only set if the database has been soft deleted.
428433
&quot;earliestVersionTime&quot;: &quot;A String&quot;, # Output only. The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with `now - version_retention_period`. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.
429434
&quot;etag&quot;: &quot;A String&quot;, # 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.
430435
&quot;keyPrefix&quot;: &quot;A String&quot;, # Output only. The key_prefix for this database. This key_prefix is used, in combination with the project id (&quot;~&quot;) 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).

googleapiclient/discovery_cache/documents/firestore.v1.json

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,11 @@
276276
"pattern": "^projects/[^/]+$",
277277
"required": true,
278278
"type": "string"
279+
},
280+
"showDeleted": {
281+
"description": "If true, also returns deleted resources.",
282+
"location": "query",
283+
"type": "boolean"
279284
}
280285
},
281286
"path": "v1/{+parent}/databases",
@@ -1672,7 +1677,7 @@
16721677
}
16731678
}
16741679
},
1675-
"revision": "20240420",
1680+
"revision": "20240430",
16761681
"rootUrl": "https://firestore.googleapis.com/",
16771682
"schemas": {
16781683
"Aggregation": {
@@ -2571,6 +2576,12 @@
25712576
],
25722577
"type": "string"
25732578
},
2579+
"deleteTime": {
2580+
"description": "Output only. The timestamp at which this database was soft deleted. Only set if the database has been soft deleted.",
2581+
"format": "google-datetime",
2582+
"readOnly": true,
2583+
"type": "string"
2584+
},
25742585
"earliestVersionTime": {
25752586
"description": "Output only. The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with `now - version_retention_period`. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.",
25762587
"format": "google-datetime",

googleapiclient/discovery_cache/documents/firestore.v1beta1.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -950,7 +950,7 @@
950950
}
951951
}
952952
},
953-
"revision": "20240420",
953+
"revision": "20240430",
954954
"rootUrl": "https://firestore.googleapis.com/",
955955
"schemas": {
956956
"Aggregation": {

googleapiclient/discovery_cache/documents/firestore.v1beta2.json

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

0 commit comments

Comments
 (0)