Package com.google.cloud.kms.v1

Class ListKeyRingsRequest.Builder

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

    • 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<ListKeyRingsRequest.Builder>

      • clear

        public ListKeyRingsRequest.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<ListKeyRingsRequest.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<ListKeyRingsRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public ListKeyRingsRequest.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<ListKeyRingsRequest.Builder>

      • setField

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

      • clearField

        public ListKeyRingsRequest.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<ListKeyRingsRequest.Builder>

      • clearOneof

        public ListKeyRingsRequest.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<ListKeyRingsRequest.Builder>

      • setRepeatedField

        public ListKeyRingsRequest.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<ListKeyRingsRequest.Builder>

      • addRepeatedField

        public ListKeyRingsRequest.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<ListKeyRingsRequest.Builder>

      • mergeFrom

        public ListKeyRingsRequest.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListKeyRingsRequest.Builder>

      • isInitialized

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

      • mergeFrom

        public ListKeyRingsRequest.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<ListKeyRingsRequest.Builder>
        Throws:
        IOException

      • getParent

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

      • getParentBytes

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

      • setParent

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

      • clearParent

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

      • setParentBytes

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

      • getPageSize

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

      • setPageSize

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

      • clearPageSize

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

      • getPageToken

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

      • getPageTokenBytes

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

      • setPageToken

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

      • clearPageToken

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

      • setPageTokenBytes

        public ListKeyRingsRequest.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         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];
        Parameters:
        value - The bytes for pageToken to set.
        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 = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilter in interface ListKeyRingsRequestOrBuilder
        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 = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilterBytes in interface ListKeyRingsRequestOrBuilder
        Returns:
        The bytes for filter.

      • setFilter

        public ListKeyRingsRequest.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 = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The filter to set.
        Returns:
        This builder for chaining.

      • clearFilter

        public ListKeyRingsRequest.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 = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setFilterBytes

        public ListKeyRingsRequest.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 = 4 [(.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 = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getOrderBy in interface ListKeyRingsRequestOrBuilder
        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 = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getOrderByBytes in interface ListKeyRingsRequestOrBuilder
        Returns:
        The bytes for orderBy.

      • setOrderBy

        public ListKeyRingsRequest.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 = 5 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The orderBy to set.
        Returns:
        This builder for chaining.

      • clearOrderBy

        public ListKeyRingsRequest.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 = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setOrderByBytes

        public ListKeyRingsRequest.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 = 5 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for orderBy to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final ListKeyRingsRequest.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<ListKeyRingsRequest.Builder>

      • mergeUnknownFields

        public final ListKeyRingsRequest.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<ListKeyRingsRequest.Builder>