public sealed class ListCryptoKeysRequest : IPageRequest, IMessage<ListCryptoKeysRequest>, IEquatable<ListCryptoKeysRequest>, IDeepCloneable<ListCryptoKeysRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Google Cloud Key Management Service v1 API class ListCryptoKeysRequest.
Request message for [KeyManagementService.ListCryptoKeys][google.cloud.kms.v1.KeyManagementService.ListCryptoKeys].
Implements
IPageRequest, IMessageListCryptoKeysRequest, IEquatableListCryptoKeysRequest, IDeepCloneableListCryptoKeysRequest, IBufferMessage, IMessageNamespace
GoogleGoogle.CloudGoogle.Cloud.KmsV1Assembly
Google.Cloud.Kms.V1.dll
Constructors
ListCryptoKeysRequest()
public ListCryptoKeysRequest()
ListCryptoKeysRequest(ListCryptoKeysRequest)
public ListCryptoKeysRequest(ListCryptoKeysRequest other)
Parameter | |
---|---|
Name | Description |
other | ListCryptoKeysRequest |
Properties
Filter
public string Filter { get; set; }
Optional. Only include resources that match the filter in the response. For more information, see Sorting and filtering list results.
Property Value | |
---|---|
Type | Description |
string |
OrderBy
public string OrderBy { get; set; }
Optional. Specify how the results should be sorted. If not specified, the results will be sorted in the default order. For more information, see Sorting and filtering list results.
Property Value | |
---|---|
Type | Description |
string |
PageSize
public int PageSize { get; set; }
Optional. Optional limit on the number of [CryptoKeys][google.cloud.kms.v1.CryptoKey] to include in the response. Further [CryptoKeys][google.cloud.kms.v1.CryptoKey] can subsequently be obtained by including the [ListCryptoKeysResponse.next_page_token][google.cloud.kms.v1.ListCryptoKeysResponse.next_page_token] in a subsequent request. If unspecified, the server will pick an appropriate default.
Property Value | |
---|---|
Type | Description |
int |
PageToken
public string PageToken { get; set; }
Optional. Optional pagination token, returned earlier via [ListCryptoKeysResponse.next_page_token][google.cloud.kms.v1.ListCryptoKeysResponse.next_page_token].
Property Value | |
---|---|
Type | Description |
string |
Parent
public string Parent { get; set; }
Required. The resource name of the [KeyRing][google.cloud.kms.v1.KeyRing]
to list, in the format projects/*/locations/*/keyRings/*
.
Property Value | |
---|---|
Type | Description |
string |
ParentAsKeyRingName
public KeyRingName ParentAsKeyRingName { get; set; }
KeyRingName-typed view over the Parent resource name property.
Property Value | |
---|---|
Type | Description |
KeyRingName |
VersionView
public CryptoKeyVersion.Types.CryptoKeyVersionView VersionView { get; set; }
The fields of the primary version to include in the response.
Property Value | |
---|---|
Type | Description |
CryptoKeyVersionTypesCryptoKeyVersionView |