feat(firestore): update the api

#### firestore:v1 The following keys were added: - schemas.GoogleFirestoreAdminV1CmekConfig (Total Keys: 6) - schemas.GoogleFirestoreAdminV1Database.properties.cmekConfig.$ref (Total Keys: 1)
googleapis · Mar 19, 2024 · 9703f76 · 9703f76
1 parent 6f19aee
commit 9703f76
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 5 deletions.
diff --git a/docs/dyn/firestore_v1.projects.databases.html b/docs/dyn/firestore_v1.projects.databases.html
@@ -138,6 +138,12 @@ <h3>Method Details</h3>
 
 { # A Cloud Firestore Database.
   &quot;appEngineIntegrationMode&quot;: &quot;A String&quot;, # The App Engine integration mode to use for this database.
+  &quot;cmekConfig&quot;: { # The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. # Optional. Presence indicates CMEK is enabled for this database.
+    &quot;activeKeyVersion&quot;: [ # Output only. Currently in-use [KMS key versions](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions). During [key rotation](https://cloud.google.com/kms/docs/key-rotation), there can be multiple in-use key versions. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}`.
+      &quot;A String&quot;,
+    ],
+    &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. Only keys in the same location as this database are allowed to be used for encryption. For Firestore&#x27;s nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore&#x27;s eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
+  },
   &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.
@@ -284,6 +290,12 @@ <h3>Method Details</h3>
 
     { # A Cloud Firestore Database.
   &quot;appEngineIntegrationMode&quot;: &quot;A String&quot;, # The App Engine integration mode to use for this database.
+  &quot;cmekConfig&quot;: { # The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. # Optional. Presence indicates CMEK is enabled for this database.
+    &quot;activeKeyVersion&quot;: [ # Output only. Currently in-use [KMS key versions](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions). During [key rotation](https://cloud.google.com/kms/docs/key-rotation), there can be multiple in-use key versions. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}`.
+      &quot;A String&quot;,
+    ],
+    &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. Only keys in the same location as this database are allowed to be used for encryption. For Firestore&#x27;s nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore&#x27;s eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
+  },
   &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.
@@ -366,6 +378,12 @@ <h3>Method Details</h3>
   &quot;databases&quot;: [ # The databases in the project.
     { # A Cloud Firestore Database.
       &quot;appEngineIntegrationMode&quot;: &quot;A String&quot;, # The App Engine integration mode to use for this database.
+      &quot;cmekConfig&quot;: { # The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. # Optional. Presence indicates CMEK is enabled for this database.
+        &quot;activeKeyVersion&quot;: [ # Output only. Currently in-use [KMS key versions](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions). During [key rotation](https://cloud.google.com/kms/docs/key-rotation), there can be multiple in-use key versions. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}`.
+          &quot;A String&quot;,
+        ],
+        &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. Only keys in the same location as this database are allowed to be used for encryption. For Firestore&#x27;s nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore&#x27;s eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
+      },
       &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.
@@ -398,6 +416,12 @@ <h3>Method Details</h3>
 
 { # A Cloud Firestore Database.
   &quot;appEngineIntegrationMode&quot;: &quot;A String&quot;, # The App Engine integration mode to use for this database.
+  &quot;cmekConfig&quot;: { # The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. # Optional. Presence indicates CMEK is enabled for this database.
+    &quot;activeKeyVersion&quot;: [ # Output only. Currently in-use [KMS key versions](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions). During [key rotation](https://cloud.google.com/kms/docs/key-rotation), there can be multiple in-use key versions. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}`.
+      &quot;A String&quot;,
+    ],
+    &quot;kmsKeyName&quot;: &quot;A String&quot;, # Required. Only keys in the same location as this database are allowed to be used for encryption. For Firestore&#x27;s nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore&#x27;s eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
+  },
   &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.

diff --git a/docs/dyn/firestore_v1.projects.locations.backups.html b/docs/dyn/firestore_v1.projects.locations.backups.html
@@ -154,7 +154,7 @@ <h3>Method Details</h3>
   An object of the form:
 
     { # The response for FirestoreAdmin.ListBackups.
-  &quot;backups&quot;: [ # List of all backups for the project. Ordered by `location ASC, create_time DESC, name ASC`.
+  &quot;backups&quot;: [ # List of all backups for the project.
     { # A Backup of a Cloud Firestore Database. The backup contains all documents and index configurations for the given database at a specific point in time.
       &quot;database&quot;: &quot;A String&quot;, # Output only. Name of the Firestore database that the backup is from. Format is `projects/{project}/databases/{database}`.
       &quot;databaseUid&quot;: &quot;A String&quot;, # Output only. The system-generated UUID4 for the Firestore database that the backup is from.

diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json
@@ -1672,7 +1672,7 @@
 }
 }
 },
-"revision": "20240226",
+"revision": "20240307",
 "rootUrl": "https://firestore.googleapis.com/",
 "schemas": {
 "Aggregation": {
@@ -2390,6 +2390,25 @@
 },
 "type": "object"
 },
+"GoogleFirestoreAdminV1CmekConfig": {
+"description": "The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key.",
+"id": "GoogleFirestoreAdminV1CmekConfig",
+"properties": {
+"activeKeyVersion": {
+"description": "Output only. Currently in-use [KMS key versions](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions). During [key rotation](https://cloud.google.com/kms/docs/key-rotation), there can be multiple in-use key versions. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}`.",
+"items": {
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
+"kmsKeyName": {
+"description": "Required. Only keys in the same location as this database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleFirestoreAdminV1CreateDatabaseMetadata": {
 "description": "Metadata related to the create database operation.",
 "id": "GoogleFirestoreAdminV1CreateDatabaseMetadata",
@@ -2420,6 +2439,10 @@
 ],
 "type": "string"
 },
+"cmekConfig": {
+"$ref": "GoogleFirestoreAdminV1CmekConfig",
+"description": "Optional. Presence indicates CMEK is enabled for this database."
+},
 "concurrencyMode": {
 "description": "The concurrency control mode to use for this database.",
 "enum": [
@@ -3069,7 +3092,7 @@
 "id": "GoogleFirestoreAdminV1ListBackupsResponse",
 "properties": {
 "backups": {
-"description": "List of all backups for the project. Ordered by `location ASC, create_time DESC, name ASC`.",
+"description": "List of all backups for the project.",
 "items": {
 "$ref": "GoogleFirestoreAdminV1Backup"
 },

diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json
@@ -950,7 +950,7 @@
 }
 }
 },
-"revision": "20240226",
+"revision": "20240307",
 "rootUrl": "https://firestore.googleapis.com/",
 "schemas": {
 "Aggregation": {

diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta2.json b/googleapiclient/discovery_cache/documents/firestore.v1beta2.json
@@ -415,7 +415,7 @@
 }
 }
 },
-"revision": "20240226",
+"revision": "20240307",
 "rootUrl": "https://firestore.googleapis.com/",
 "schemas": {
 "Empty": {