Package com.google.cloud.kms.v1

Class ListCryptoKeysRequest.Builder

  • All Implemented Interfaces:
    ListCryptoKeysRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    ListCryptoKeysRequest
    public static final class ListCryptoKeysRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ListCryptoKeysRequest.Builder>
implements ListCryptoKeysRequestOrBuilder
     Request message for
 [KeyManagementService.ListCryptoKeys][google.cloud.kms.v1.KeyManagementService.ListCryptoKeys].
    Protobuf type google.cloud.kms.v1.ListCryptoKeysRequest

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ListCryptoKeysRequest.Builder>

      • clear

        public ListCryptoKeysRequest.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<ListCryptoKeysRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListCryptoKeysRequest.Builder>

      • getDefaultInstanceForType

        public ListCryptoKeysRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public ListCryptoKeysRequest build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public ListCryptoKeysRequest buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public ListCryptoKeysRequest.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<ListCryptoKeysRequest.Builder>

      • clearField

        public ListCryptoKeysRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListCryptoKeysRequest.Builder>

      • clearOneof

        public ListCryptoKeysRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListCryptoKeysRequest.Builder>

      • setRepeatedField

        public ListCryptoKeysRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      int index,
                                                      Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListCryptoKeysRequest.Builder>

      • addRepeatedField

        public ListCryptoKeysRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListCryptoKeysRequest.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListCryptoKeysRequest.Builder>

      • mergeFrom

        public ListCryptoKeysRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListCryptoKeysRequest.Builder>
        Throws:
        IOException

      • getParent

        public 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) = { ... }
        Specified by:
        getParent in interface ListCryptoKeysRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public 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) = { ... }
        Specified by:
        getParentBytes in interface ListCryptoKeysRequestOrBuilder
        Returns:
        The bytes for parent.

      • setParent

        public ListCryptoKeysRequest.Builder setParent​(String value)
         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) = { ... }
        Parameters:
        value - The parent to set.
        Returns:
        This builder for chaining.

      • clearParent

        public ListCryptoKeysRequest.Builder clearParent()
         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:
        This builder for chaining.

      • setParentBytes

        public ListCryptoKeysRequest.Builder setParentBytes​(com.google.protobuf.ByteString value)
         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) = { ... }
        Parameters:
        value - The bytes for parent to set.
        Returns:
        This builder for chaining.

      • getPageSize

        public 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];
        Specified by:
        getPageSize in interface ListCryptoKeysRequestOrBuilder
        Returns:
        The pageSize.

      • setPageSize

        public ListCryptoKeysRequest.Builder setPageSize​(int value)
         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];
        Parameters:
        value - The pageSize to set.
        Returns:
        This builder for chaining.

      • clearPageSize

        public ListCryptoKeysRequest.Builder clearPageSize()
         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:
        This builder for chaining.

      • getPageToken

        public 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];
        Specified by:
        getPageToken in interface ListCryptoKeysRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public 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];
        Specified by:
        getPageTokenBytes in interface ListCryptoKeysRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • setPageToken

        public ListCryptoKeysRequest.Builder setPageToken​(String value)
         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];
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.

      • clearPageToken

        public ListCryptoKeysRequest.Builder clearPageToken()
         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:
        This builder for chaining.

      • setPageTokenBytes

        public ListCryptoKeysRequest.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.

      • getVersionViewValue

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

      • setVersionViewValue

        public ListCryptoKeysRequest.Builder setVersionViewValue​(int value)
         The fields of the primary version to include in the response.
        .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionView version_view = 4;
        Parameters:
        value - The enum numeric value on the wire for versionView to set.
        Returns:
        This builder for chaining.

      • setVersionView

        public ListCryptoKeysRequest.Builder setVersionView​(CryptoKeyVersion.CryptoKeyVersionView value)
         The fields of the primary version to include in the response.
        .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionView version_view = 4;
        Parameters:
        value - The versionView to set.
        Returns:
        This builder for chaining.

      • clearVersionView

        public ListCryptoKeysRequest.Builder clearVersionView()
         The fields of the primary version to include in the response.
        .google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionView version_view = 4;
        Returns:
        This builder for chaining.

      • getFilter

        public 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];
        Specified by:
        getFilter in interface ListCryptoKeysRequestOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public 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];
        Specified by:
        getFilterBytes in interface ListCryptoKeysRequestOrBuilder
        Returns:
        The bytes for filter.

      • setFilter

        public ListCryptoKeysRequest.Builder setFilter​(String value)
         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];
        Parameters:
        value - The filter to set.
        Returns:
        This builder for chaining.

      • clearFilter

        public ListCryptoKeysRequest.Builder clearFilter()
         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:
        This builder for chaining.

      • setFilterBytes

        public ListCryptoKeysRequest.Builder setFilterBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes for filter to set.
        Returns:
        This builder for chaining.

      • 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](https://cloud.google.com/kms/docs/sorting-and-filtering).
        string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getOrderBy in interface ListCryptoKeysRequestOrBuilder
        Returns:
        The orderBy.

      • getOrderByBytes

        public 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];
        Specified by:
        getOrderByBytes in interface ListCryptoKeysRequestOrBuilder
        Returns:
        The bytes for orderBy.

      • setOrderBy

        public ListCryptoKeysRequest.Builder setOrderBy​(String value)
         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];
        Parameters:
        value - The orderBy to set.
        Returns:
        This builder for chaining.

      • clearOrderBy

        public ListCryptoKeysRequest.Builder clearOrderBy()
         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:
        This builder for chaining.

      • setOrderByBytes

        public ListCryptoKeysRequest.Builder setOrderByBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes for orderBy to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final ListCryptoKeysRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListCryptoKeysRequest.Builder>

      • mergeUnknownFields

        public final ListCryptoKeysRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListCryptoKeysRequest.Builder>