Package com.google.cloud.kms.v1

Interface ListKeyRingsRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ListKeyRingsRequest, ListKeyRingsRequest.Builder
    public interface ListKeyRingsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getFilter()
      Optional.
      com.google.protobuf.ByteString getFilterBytes()
      Optional.
      String getOrderBy()
      Optional.
      com.google.protobuf.ByteString getOrderByBytes()
      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.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getParent

        String getParent()
         Required. The resource name of the location associated with the
 [KeyRings][google.cloud.kms.v1.KeyRing], in the format
 `projects/*/locations/*`.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The parent.

      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Required. The resource name of the location associated with the
 [KeyRings][google.cloud.kms.v1.KeyRing], in the format
 `projects/*/locations/*`.
        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
 [KeyRings][google.cloud.kms.v1.KeyRing] to include in the response. Further
 [KeyRings][google.cloud.kms.v1.KeyRing] can subsequently be obtained by
 including the
 [ListKeyRingsResponse.next_page_token][google.cloud.kms.v1.ListKeyRingsResponse.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:
        The pageSize.

      • getPageToken

        String getPageToken()
         Optional. Optional pagination token, returned earlier via
 [ListKeyRingsResponse.next_page_token][google.cloud.kms.v1.ListKeyRingsResponse.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
 [ListKeyRingsResponse.next_page_token][google.cloud.kms.v1.ListKeyRingsResponse.next_page_token].
        string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for pageToken.

      • getFilter

        String getFilter()
         Optional. Only include resources that match the filter in the response. For
 more information, see
 [Sorting and filtering list
 results](https://cloud.google.com/kms/docs/sorting-and-filtering).
        string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The filter.

      • getFilterBytes

        com.google.protobuf.ByteString getFilterBytes()
         Optional. Only include resources that match the filter in the response. For
 more information, see
 [Sorting and filtering list
 results](https://cloud.google.com/kms/docs/sorting-and-filtering).
        string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for filter.

      • getOrderBy

        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](https://cloud.google.com/kms/docs/sorting-and-filtering).
        string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The orderBy.

      • getOrderByBytes

        com.google.protobuf.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](https://cloud.google.com/kms/docs/sorting-and-filtering).
        string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for orderBy.