Class ListCryptoKeysRequest (2.46.0)
Version 2.46.0keyboard_arrow_down
public final class ListCryptoKeysRequest extends GeneratedMessageV3 implements ListCryptoKeysRequestOrBuilder
Request message for
KeyManagementService.ListCryptoKeys .
Protobuf type google.cloud.kms.v1.ListCryptoKeysRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
Field Value
Type Description
int
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int
VERSION_VIEW_FIELD_NUMBER
public static final int VERSION_VIEW_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static ListCryptoKeysRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static ListCryptoKeysRequest . Builder newBuilder ()
newBuilder(ListCryptoKeysRequest prototype)
public static ListCryptoKeysRequest . Builder newBuilder ( ListCryptoKeysRequest prototype )
public static ListCryptoKeysRequest parseDelimitedFrom ( InputStream input )
public static ListCryptoKeysRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static ListCryptoKeysRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListCryptoKeysRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static ListCryptoKeysRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListCryptoKeysRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static ListCryptoKeysRequest parseFrom ( CodedInputStream input )
public static ListCryptoKeysRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static ListCryptoKeysRequest parseFrom ( InputStream input )
public static ListCryptoKeysRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static ListCryptoKeysRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListCryptoKeysRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<ListCryptoKeysRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public ListCryptoKeysRequest getDefaultInstanceForType ()
getFilter()
public String getFilter ()
Optional. Only include resources that match the filter in the response. For
more information, see
Sorting and filtering list
results .
string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
String The filter.
getFilterBytes()
public ByteString getFilterBytes ()
Optional. Only include resources that match the filter in the response. For
more information, see
Sorting and filtering list
results .
string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
ByteString The bytes for filter.
getOrderBy()
public String getOrderBy ()
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 .
string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
String The orderBy.
getOrderByBytes()
public ByteString getOrderByBytes ()
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 .
string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
ByteString The bytes for orderBy.
getPageSize()
Optional. Optional limit on the number of
CryptoKeys to include in the response.
Further CryptoKeys can subsequently be
obtained by including the
ListCryptoKeysResponse.next_page_token
in a subsequent request. If unspecified, the server will pick an
appropriate default.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int The pageSize.
getPageToken()
public String getPageToken ()
Optional. Optional pagination token, returned earlier via
ListCryptoKeysResponse.next_page_token .
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
String The pageToken.
getPageTokenBytes()
public ByteString getPageTokenBytes ()
Optional. Optional pagination token, returned earlier via
ListCryptoKeysResponse.next_page_token .
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
ByteString The bytes for pageToken.
getParent()
public String getParent ()
Required. The resource name of the KeyRing
to list, in the format projects/*/locations/*/keyRings/*.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
Type Description
String The parent.
getParentBytes()
public ByteString getParentBytes ()
Required. The resource name of the KeyRing
to list, in the format projects/*/locations/*/keyRings/*.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
Type Description
ByteString The bytes for parent.
getParserForType()
public Parser<ListCryptoKeysRequest> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getVersionView()
public CryptoKeyVersion . CryptoKeyVersionView getVersionView ()
The fields of the primary version to include in the response.
.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionView version_view = 4;
getVersionViewValue()
public int getVersionViewValue ()
The fields of the primary version to include in the response.
.google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionView version_view = 4;
Returns
Type Description
int The enum numeric value on the wire for versionView.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public ListCryptoKeysRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListCryptoKeysRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public ListCryptoKeysRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
