Interface ListCryptoKeysRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ListCryptoKeysRequest, ListCryptoKeysRequest.Builder

    public interface ListCryptoKeysRequestOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Detail

      • getParent

        String getParent()
         Required. The resource name of the [KeyRing][google.cloud.kms.v1.KeyRing]
         to list, in the format `projects/*/locations/*/keyRings/*`.
         
        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 [KeyRing][google.cloud.kms.v1.KeyRing]
         to list, in the format `projects/*/locations/*/keyRings/*`.
         
        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
         [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.
         
        int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The pageSize.
      • getPageToken

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

        int getVersionViewValue()
         The fields of the primary version to include in the response.
         
        .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionView version_view = 4;
        Returns:
        The enum numeric value on the wire for versionView.
      • getVersionView

        CryptoKeyVersion.CryptoKeyVersionView getVersionView()
         The fields of the primary version to include in the response.
         
        .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionView version_view = 4;
        Returns:
        The versionView.
      • 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 = 5 [(.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 = 5 [(.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 = 6 [(.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 = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for orderBy.