public final class ListCryptoKeysRequest extends GeneratedMessageV3 implements ListCryptoKeysRequestOrBuilder
Request message for
KeyManagementService.ListCryptoKeys.
Protobuf type google.cloud.kms.v1.ListCryptoKeysRequest
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
VERSION_VIEW_FIELD_NUMBER
public static final int VERSION_VIEW_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ListCryptoKeysRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ListCryptoKeysRequest.Builder newBuilder()
Returns
newBuilder(ListCryptoKeysRequest prototype)
public static ListCryptoKeysRequest.Builder newBuilder(ListCryptoKeysRequest prototype)
Parameter
Returns
public static ListCryptoKeysRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListCryptoKeysRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ListCryptoKeysRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListCryptoKeysRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ListCryptoKeysRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListCryptoKeysRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListCryptoKeysRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListCryptoKeysRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListCryptoKeysRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListCryptoKeysRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ListCryptoKeysRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListCryptoKeysRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ListCryptoKeysRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public ListCryptoKeysRequest getDefaultInstanceForType()
Returns
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];
| 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];
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];
| 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];
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];
| 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];
| 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];
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) = { ... }
| 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) = { ... }
getParserForType()
public Parser<ListCryptoKeysRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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;
| Type | Description |
| int | The enum numeric value on the wire for versionView.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ListCryptoKeysRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListCryptoKeysRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ListCryptoKeysRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
