fix!: Pagination feature is introduced for method ListKeyHandles in service Autokey

Google APIs · copybara-github · commit 42492c963aaa · 2024-09-18T11:34:51.000-07:00
feat: Adding a state field for AutokeyConfig

docs: Field service_resolvers in message .google.cloud.kms.v1.EkmConnection is Explicitly is marked as to have field behavior of Optional

docs: A comment for field `destroy_scheduled_duration` in message `.google.cloud.kms.v1.CryptoKey` is updated for the default duration
PiperOrigin-RevId: 676068244
diff --git a/google/cloud/kms/v1/autokey.proto b/google/cloud/kms/v1/autokey.proto
@@ -27,7 +27,8 @@ option java_multiple_files = true;
 option java_outer_classname = "AutokeyProto";
 option java_package = "com.google.cloud.kms.v1";
 
-// Provides interfaces for using Cloud KMS Autokey to provision new
+// Provides interfaces for using [Cloud KMS
+// Autokey](https://cloud.google.com/kms/help/autokey) to provision new
 // [CryptoKeys][google.cloud.kms.v1.CryptoKey], ready for Customer Managed
 // Encryption Key (CMEK) use, on-demand. To support certain client tooling, this
 // feature is modeled around a [KeyHandle][google.cloud.kms.v1.KeyHandle]
@@ -180,6 +181,20 @@ message ListKeyHandlesRequest {
     }
   ];
 
+  // Optional. Optional limit on the number of
+  // [KeyHandles][google.cloud.kms.v1.KeyHandle] to include in the response. The
+  // service may return fewer than this value. Further
+  // [KeyHandles][google.cloud.kms.v1.KeyHandle] can subsequently be obtained by
+  // including the
+  // [ListKeyHandlesResponse.next_page_token][google.cloud.kms.v1.ListKeyHandlesResponse.next_page_token]
+  // in a subsequent request.  If unspecified, at most
+  // 100 [KeyHandles][google.cloud.kms.v1.KeyHandle] will be returned.
+  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Optional pagination token, returned earlier via
+  // [ListKeyHandlesResponse.next_page_token][google.cloud.kms.v1.ListKeyHandlesResponse.next_page_token].
+  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
+
   // Optional. Filter to apply when listing
   // [KeyHandles][google.cloud.kms.v1.KeyHandle], e.g.
   // `resource_type_selector="{SERVICE}.googleapis.com/{TYPE}"`.
@@ -191,4 +206,9 @@ message ListKeyHandlesRequest {
 message ListKeyHandlesResponse {
   // Resulting [KeyHandles][google.cloud.kms.v1.KeyHandle].
   repeated KeyHandle key_handles = 1;
+
+  // A token to retrieve next page of results. Pass this value in
+  // [ListKeyHandlesRequest.page_token][google.cloud.kms.v1.ListKeyHandlesRequest.page_token]
+  // to retrieve the next page of results.
+  string next_page_token = 2;
 }
diff --git a/google/cloud/kms/v1/autokey_admin.proto b/google/cloud/kms/v1/autokey_admin.proto
@@ -27,7 +27,8 @@ option java_multiple_files = true;
 option java_outer_classname = "AutokeyAdminProto";
 option java_package = "com.google.cloud.kms.v1";
 
-// Provides interfaces for managing Cloud KMS Autokey folder-level
+// Provides interfaces for managing [Cloud KMS
+// Autokey](https://cloud.google.com/kms/help/autokey) folder-level
 // configurations. A configuration is inherited by all descendent projects. A
 // configuration at one folder overrides any other configurations in its
 // ancestry. Setting a configuration on a folder is a prerequisite for Cloud KMS
@@ -110,6 +111,23 @@ message AutokeyConfig {
     singular: "autokeyConfig"
   };
 
+  // The states AutokeyConfig can be in.
+  enum State {
+    // The state of the AutokeyConfig is unspecified.
+    STATE_UNSPECIFIED = 0;
+
+    // The AutokeyConfig is currently active.
+    ACTIVE = 1;
+
+    // A previously configured key project has been deleted and the current
+    // AutokeyConfig is unusable.
+    KEY_PROJECT_DELETED = 2;
+
+    // The AutokeyConfig is not yet initialized or has been reset to its default
+    // uninitialized state.
+    UNINITIALIZED = 3;
+  }
+
   // Identifier. Name of the [AutokeyConfig][google.cloud.kms.v1.AutokeyConfig]
   // resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`.
   string name = 1 [(google.api.field_behavior) = IDENTIFIER];
@@ -126,6 +144,9 @@ message AutokeyConfig {
   // `cloudkms.admin` role (or pertinent permissions). A request with an empty
   // key project field will clear the configuration.
   string key_project = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Output only. The state for the AutokeyConfig.
+  State state = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
 // Request message for
diff --git a/google/cloud/kms/v1/ekm_service.proto b/google/cloud/kms/v1/ekm_service.proto
@@ -378,13 +378,14 @@ message EkmConnection {
   google.protobuf.Timestamp create_time = 2
       [(google.api.field_behavior) = OUTPUT_ONLY];
 
-  // A list of
+  // Optional. A list of
   // [ServiceResolvers][google.cloud.kms.v1.EkmConnection.ServiceResolver] where
   // the EKM can be reached. There should be one ServiceResolver per EKM
   // replica. Currently, only a single
   // [ServiceResolver][google.cloud.kms.v1.EkmConnection.ServiceResolver] is
   // supported.
-  repeated ServiceResolver service_resolvers = 3;
+  repeated ServiceResolver service_resolvers = 3
+      [(google.api.field_behavior) = OPTIONAL];
 
   // Optional. Etag of the currently stored
   // [EkmConnection][google.cloud.kms.v1.EkmConnection].
diff --git a/google/cloud/kms/v1/resources.proto b/google/cloud/kms/v1/resources.proto
@@ -184,7 +184,7 @@ message CryptoKey {
   // [DESTROY_SCHEDULED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROY_SCHEDULED]
   // state before transitioning to
   // [DESTROYED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROYED].
-  // If not specified at creation time, the default duration is 24 hours.
+  // If not specified at creation time, the default duration is 30 days.
   google.protobuf.Duration destroy_scheduled_duration = 14
       [(google.api.field_behavior) = IMMUTABLE];
 
