Skip to content

Commit

Permalink
feat(firestore): update the api
Browse files Browse the repository at this point in the history
#### 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)
  • Loading branch information
yoshi-automation committed May 10, 2024
1 parent 2a94e44 commit ae491de
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 5 deletions.
9 changes: 7 additions & 2 deletions docs/dyn/firestore_v1.projects.databases.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ <h2>Instance Methods</h2>
<code><a href="#importDocuments">importDocuments(name, body=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
<code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
<code><a href="#list">list(parent, showDeleted=None, x__xgafv=None)</a></code></p>
<p class="firstline">List all the databases in the project.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Expand Down Expand Up @@ -147,6 +147,7 @@ <h3>Method Details</h3>
&quot;concurrencyMode&quot;: &quot;A String&quot;, # The concurrency control mode to use for this database.
&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.
&quot;deleteProtectionState&quot;: &quot;A String&quot;, # State of delete protection for the database.
&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.
&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.
&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.
&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).
Expand Down Expand Up @@ -299,6 +300,7 @@ <h3>Method Details</h3>
&quot;concurrencyMode&quot;: &quot;A String&quot;, # The concurrency control mode to use for this database.
&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.
&quot;deleteProtectionState&quot;: &quot;A String&quot;, # State of delete protection for the database.
&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.
&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.
&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.
&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).
Expand Down Expand Up @@ -361,11 +363,12 @@ <h3>Method Details</h3>
</div>

<div class="method">
<code class="details" id="list">list(parent, x__xgafv=None)</code>
<code class="details" id="list">list(parent, showDeleted=None, x__xgafv=None)</code>
<pre>List all the databases in the project.

Args:
parent: string, Required. A parent name of the form `projects/{project_id}` (required)
showDeleted: boolean, If true, also returns deleted resources.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
Expand All @@ -387,6 +390,7 @@ <h3>Method Details</h3>
&quot;concurrencyMode&quot;: &quot;A String&quot;, # The concurrency control mode to use for this database.
&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.
&quot;deleteProtectionState&quot;: &quot;A String&quot;, # State of delete protection for the database.
&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.
&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.
&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.
&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).
Expand Down Expand Up @@ -425,6 +429,7 @@ <h3>Method Details</h3>
&quot;concurrencyMode&quot;: &quot;A String&quot;, # The concurrency control mode to use for this database.
&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.
&quot;deleteProtectionState&quot;: &quot;A String&quot;, # State of delete protection for the database.
&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.
&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.
&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.
&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).
Expand Down
13 changes: 12 additions & 1 deletion googleapiclient/discovery_cache/documents/firestore.v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,11 @@
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"showDeleted": {
"description": "If true, also returns deleted resources.",
"location": "query",
"type": "boolean"
}
},
"path": "v1/{+parent}/databases",
Expand Down Expand Up @@ -1672,7 +1677,7 @@
}
}
},
"revision": "20240420",
"revision": "20240430",
"rootUrl": "https://firestore.googleapis.com/",
"schemas": {
"Aggregation": {
Expand Down Expand Up @@ -2571,6 +2576,12 @@
],
"type": "string"
},
"deleteTime": {
"description": "Output only. The timestamp at which this database was soft deleted. Only set if the database has been soft deleted.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"earliestVersionTime": {
"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.",
"format": "google-datetime",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -950,7 +950,7 @@
}
}
},
"revision": "20240420",
"revision": "20240430",
"rootUrl": "https://firestore.googleapis.com/",
"schemas": {
"Aggregation": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -415,7 +415,7 @@
}
}
},
"revision": "20240420",
"revision": "20240430",
"rootUrl": "https://firestore.googleapis.com/",
"schemas": {
"Empty": {
Expand Down

0 comments on commit ae491de

Please sign in to comment.