com.google.cloud.kms.v1

Interface ListKeyHandlesRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListKeyHandlesRequest, ListKeyHandlesRequest.Builder

public interface ListKeyHandlesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFilter() Optional.
com.google.protobuf.ByteString	getFilterBytes() Optional.
int	getPageSize() Optional.
String	getPageToken() Optional.
com.google.protobuf.ByteString	getPageTokenBytes() Optional.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

String getParent()

 Required. Name of the resource project and location from which to list
 [KeyHandles][google.cloud.kms.v1.KeyHandle], e.g.
 `projects/{PROJECT_ID}/locations/{LOCATION}`.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The parent.

getParentBytes

com.google.protobuf.ByteString getParentBytes()

 Required. Name of the resource project and location from which to list
 [KeyHandles][google.cloud.kms.v1.KeyHandle], e.g.
 `projects/{PROJECT_ID}/locations/{LOCATION}`.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for parent.

getPageSize

int getPageSize()

 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];

Returns:

The pageSize.

getPageToken

String getPageToken()

 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];

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 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];

Returns:

The bytes for pageToken.

getFilter

String getFilter()

 Optional. Filter to apply when listing
 [KeyHandles][google.cloud.kms.v1.KeyHandle], e.g.
 `resource_type_selector="{SERVICE}.googleapis.com/{TYPE}"`.
 

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The filter.

getFilterBytes

com.google.protobuf.ByteString getFilterBytes()

 Optional. Filter to apply when listing
 [KeyHandles][google.cloud.kms.v1.KeyHandle], e.g.
 `resource_type_selector="{SERVICE}.googleapis.com/{TYPE}"`.
 

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for filter.