Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix!: [kmsinventory] Pagination feature is introduced for method ListKeyHandles in service Autokey #5690

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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}"`.
Expand All @@ -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;
}
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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];
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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];

Expand Down
Loading