feat: [google-cloud-kms] Adding eTag field to AutokeyConfig (#13911)

BEGIN_COMMIT_OVERRIDE
feat: Adding eTag field to AutokeyConfig
docs: Updating docs for total_size field in KMS List APIs
END_COMMIT_OVERRIDE

- [ ] Regenerate this pull request now.

docs: Updating docs for total_size field in KMS List APIs

PiperOrigin-RevId: 758946748

Source-Link:
googleapis/googleapis@29b2bad

Source-Link:
googleapis/googleapis-gen@9ebef64
Copy-Tag:
eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWttcy8uT3dsQm90LnlhbWwiLCJoIjoiOWViZWY2NDBjOTFiOTJjODNkNGZhZmZjZTRhMTJhOTljM2ExNmQ2OSJ9

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

Author: gcf-owl-bot[bot]

packages/google-cloud-kms/google/cloud/kms_v1/types/autokey_admin.py

@@ -99,6 +99,13 @@ class AutokeyConfig(proto.Message):
             project field will clear the configuration.
         state (google.cloud.kms_v1.types.AutokeyConfig.State):
             Output only. The state for the AutokeyConfig.
+        etag (str):
+            Optional. A checksum computed by the server
+            based on the value of other fields. This may be
+            sent on update requests to ensure that the
+            client has an up-to-date value before
+            proceeding. The request will be rejected with an
+            ABORTED error on a mismatched etag.
     """
 
     class State(proto.Enum):
@@ -137,6 +144,10 @@ class State(proto.Enum):
         number=4,
         enum=State,
     )
+    etag: str = proto.Field(
+        proto.STRING,
+        number=6,
+    )
 
 
 class ShowEffectiveAutokeyConfigRequest(proto.Message):

packages/google-cloud-kms/google/cloud/kms_v1/types/ekm_service.py

@@ -111,6 +111,10 @@ class ListEkmConnectionsResponse(proto.Message):
             The total number of
             [EkmConnections][google.cloud.kms.v1.EkmConnection] that
             matched the query.
+
+            This field is not populated if
+            [ListEkmConnectionsRequest.filter][google.cloud.kms.v1.ListEkmConnectionsRequest.filter]
+            is applied.
     """
 
     @property

packages/google-cloud-kms/google/cloud/kms_v1/types/resources.py

@@ -694,6 +694,8 @@ class CryptoKeyVersionAlgorithm(proto.Enum):
         The suffix following ``HMAC_`` corresponds to the hash algorithm
         being used (eg. SHA256).
 
+        Algorithms beginning with ``PQ_`` are post-quantum.
+
         For more information, see [Key purposes and algorithms]
         (https://cloud.google.com/kms/docs/algorithms).
 
@@ -857,7 +859,7 @@ class CryptoKeyVersionState(proto.Enum):
                 [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED]
                 state.
             DESTROYED (3):
-                This version is destroyed, and the key material is no longer
+                This key material of this version is destroyed and no longer
                 stored. This version may only become
                 [ENABLED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.ENABLED]
                 again if this version is

packages/google-cloud-kms/google/cloud/kms_v1/types/service.py

@@ -321,6 +321,10 @@ class ListKeyRingsResponse(proto.Message):
         total_size (int):
             The total number of [KeyRings][google.cloud.kms.v1.KeyRing]
             that matched the query.
+
+            This field is not populated if
+            [ListKeyRingsRequest.filter][google.cloud.kms.v1.ListKeyRingsRequest.filter]
+            is applied.
     """
 
     @property
@@ -357,6 +361,10 @@ class ListCryptoKeysResponse(proto.Message):
             The total number of
             [CryptoKeys][google.cloud.kms.v1.CryptoKey] that matched the
             query.
+
+            This field is not populated if
+            [ListCryptoKeysRequest.filter][google.cloud.kms.v1.ListCryptoKeysRequest.filter]
+            is applied.
     """
 
     @property
@@ -394,6 +402,10 @@ class ListCryptoKeyVersionsResponse(proto.Message):
             The total number of
             [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion]
             that matched the query.
+
+            This field is not populated if
+            [ListCryptoKeyVersionsRequest.filter][google.cloud.kms.v1.ListCryptoKeyVersionsRequest.filter]
+            is applied.
     """
 
     @property
@@ -432,6 +444,10 @@ class ListImportJobsResponse(proto.Message):
             The total number of
             [ImportJobs][google.cloud.kms.v1.ImportJob] that matched the
             query.
+
+            This field is not populated if
+            [ListImportJobsRequest.filter][google.cloud.kms.v1.ListImportJobsRequest.filter]
+            is applied.
     """
 
     @property

packages/google-cloud-kms/tests/unit/gapic/kms_v1/test_autokey_admin.py

@@ -1121,6 +1121,7 @@ def test_update_autokey_config(request_type, transport: str = "grpc"):
             name="name_value",
             key_project="key_project_value",
             state=autokey_admin.AutokeyConfig.State.ACTIVE,
+            etag="etag_value",
         )
         response = client.update_autokey_config(request)
 
@@ -1135,6 +1136,7 @@ def test_update_autokey_config(request_type, transport: str = "grpc"):
     assert response.name == "name_value"
     assert response.key_project == "key_project_value"
     assert response.state == autokey_admin.AutokeyConfig.State.ACTIVE
+    assert response.etag == "etag_value"
 
 
 def test_update_autokey_config_non_empty_request_with_auto_populated_field():
@@ -1269,6 +1271,7 @@ async def test_update_autokey_config_async(
                 name="name_value",
                 key_project="key_project_value",
                 state=autokey_admin.AutokeyConfig.State.ACTIVE,
+                etag="etag_value",
             )
         )
         response = await client.update_autokey_config(request)
@@ -1284,6 +1287,7 @@ async def test_update_autokey_config_async(
     assert response.name == "name_value"
     assert response.key_project == "key_project_value"
     assert response.state == autokey_admin.AutokeyConfig.State.ACTIVE
+    assert response.etag == "etag_value"
 
 
 @pytest.mark.asyncio
@@ -1478,6 +1482,7 @@ def test_get_autokey_config(request_type, transport: str = "grpc"):
             name="name_value",
             key_project="key_project_value",
             state=autokey_admin.AutokeyConfig.State.ACTIVE,
+            etag="etag_value",
         )
         response = client.get_autokey_config(request)
 
@@ -1492,6 +1497,7 @@ def test_get_autokey_config(request_type, transport: str = "grpc"):
     assert response.name == "name_value"
     assert response.key_project == "key_project_value"
     assert response.state == autokey_admin.AutokeyConfig.State.ACTIVE
+    assert response.etag == "etag_value"
 
 
 def test_get_autokey_config_non_empty_request_with_auto_populated_field():
@@ -1628,6 +1634,7 @@ async def test_get_autokey_config_async(
                 name="name_value",
                 key_project="key_project_value",
                 state=autokey_admin.AutokeyConfig.State.ACTIVE,
+                etag="etag_value",
             )
         )
         response = await client.get_autokey_config(request)
@@ -1643,6 +1650,7 @@ async def test_get_autokey_config_async(
     assert response.name == "name_value"
     assert response.key_project == "key_project_value"
     assert response.state == autokey_admin.AutokeyConfig.State.ACTIVE
+    assert response.etag == "etag_value"
 
 
 @pytest.mark.asyncio
@@ -2910,6 +2918,7 @@ async def test_update_autokey_config_empty_call_grpc_asyncio():
                 name="name_value",
                 key_project="key_project_value",
                 state=autokey_admin.AutokeyConfig.State.ACTIVE,
+                etag="etag_value",
             )
         )
         await client.update_autokey_config(request=None)
@@ -2941,6 +2950,7 @@ async def test_get_autokey_config_empty_call_grpc_asyncio():
                 name="name_value",
                 key_project="key_project_value",
                 state=autokey_admin.AutokeyConfig.State.ACTIVE,
+                etag="etag_value",
             )
         )
         await client.get_autokey_config(request=None)
@@ -3032,6 +3042,7 @@ def test_update_autokey_config_rest_call_success(request_type):
         "name": "folders/sample1/autokeyConfig",
         "key_project": "key_project_value",
         "state": 1,
+        "etag": "etag_value",
     }
     # The version of a generated dependency at test runtime may differ from the version used during generation.
     # Delete any fields which are not present in the current runtime dependency
@@ -3109,6 +3120,7 @@ def get_message_fields(field):
             name="name_value",
             key_project="key_project_value",
             state=autokey_admin.AutokeyConfig.State.ACTIVE,
+            etag="etag_value",
         )
 
         # Wrap the value into a proper Response obj
@@ -3128,6 +3140,7 @@ def get_message_fields(field):
     assert response.name == "name_value"
     assert response.key_project == "key_project_value"
     assert response.state == autokey_admin.AutokeyConfig.State.ACTIVE
+    assert response.etag == "etag_value"
 
 
 @pytest.mark.parametrize("null_interceptor", [True, False])
@@ -3243,6 +3256,7 @@ def test_get_autokey_config_rest_call_success(request_type):
             name="name_value",
             key_project="key_project_value",
             state=autokey_admin.AutokeyConfig.State.ACTIVE,
+            etag="etag_value",
         )
 
         # Wrap the value into a proper Response obj
@@ -3262,6 +3276,7 @@ def test_get_autokey_config_rest_call_success(request_type):
     assert response.name == "name_value"
     assert response.key_project == "key_project_value"
     assert response.state == autokey_admin.AutokeyConfig.State.ACTIVE
+    assert response.etag == "etag_value"
 
 
 @pytest.mark.parametrize("null_interceptor", [True, False])