Package com.google.cloud.discoveryengine.v1

Class ListDocumentsRequest.Builder

  • All Implemented Interfaces:
    ListDocumentsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    ListDocumentsRequest
    public static final class ListDocumentsRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>
implements ListDocumentsRequestOrBuilder
     Request message for
 [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments]
 method.
    Protobuf type google.cloud.discoveryengine.v1.ListDocumentsRequest

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

      • clear

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • isInitialized

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

      • mergeFrom

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

      • getParent

        public String getParent()
         Required. The parent branch resource name, such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
 Use `default_branch` as the branch ID, to list documents under the default
 branch.

 If the caller does not have permission to list
 [Document][google.cloud.discoveryengine.v1.Document]s under this branch,
 regardless of whether or not this branch exists, a `PERMISSION_DENIED`
 error is returned.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface ListDocumentsRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The parent branch resource name, such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
 Use `default_branch` as the branch ID, to list documents under the default
 branch.

 If the caller does not have permission to list
 [Document][google.cloud.discoveryengine.v1.Document]s under this branch,
 regardless of whether or not this branch exists, a `PERMISSION_DENIED`
 error is returned.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface ListDocumentsRequestOrBuilder
        Returns:
        The bytes for parent.

      • setParent

        public ListDocumentsRequest.Builder setParent​(String value)
         Required. The parent branch resource name, such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
 Use `default_branch` as the branch ID, to list documents under the default
 branch.

 If the caller does not have permission to list
 [Document][google.cloud.discoveryengine.v1.Document]s under this branch,
 regardless of whether or not this branch exists, a `PERMISSION_DENIED`
 error is returned.
        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 ListDocumentsRequest.Builder clearParent()
         Required. The parent branch resource name, such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
 Use `default_branch` as the branch ID, to list documents under the default
 branch.

 If the caller does not have permission to list
 [Document][google.cloud.discoveryengine.v1.Document]s under this branch,
 regardless of whether or not this branch exists, a `PERMISSION_DENIED`
 error is returned.
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setParentBytes

        public ListDocumentsRequest.Builder setParentBytes​(com.google.protobuf.ByteString value)
         Required. The parent branch resource name, such as
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
 Use `default_branch` as the branch ID, to list documents under the default
 branch.

 If the caller does not have permission to list
 [Document][google.cloud.discoveryengine.v1.Document]s under this branch,
 regardless of whether or not this branch exists, a `PERMISSION_DENIED`
 error is returned.
        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()
         Maximum number of [Document][google.cloud.discoveryengine.v1.Document]s to
 return. If unspecified, defaults to 100. The maximum allowed value is 1000.
 Values above 1000 will be coerced to 1000.

 If this field is negative, an `INVALID_ARGUMENT` error is returned.
        int32 page_size = 2;
        Specified by:
        getPageSize in interface ListDocumentsRequestOrBuilder
        Returns:
        The pageSize.

      • setPageSize

        public ListDocumentsRequest.Builder setPageSize​(int value)
         Maximum number of [Document][google.cloud.discoveryengine.v1.Document]s to
 return. If unspecified, defaults to 100. The maximum allowed value is 1000.
 Values above 1000 will be coerced to 1000.

 If this field is negative, an `INVALID_ARGUMENT` error is returned.
        int32 page_size = 2;
        Parameters:
        value - The pageSize to set.
        Returns:
        This builder for chaining.

      • clearPageSize

        public ListDocumentsRequest.Builder clearPageSize()
         Maximum number of [Document][google.cloud.discoveryengine.v1.Document]s to
 return. If unspecified, defaults to 100. The maximum allowed value is 1000.
 Values above 1000 will be coerced to 1000.

 If this field is negative, an `INVALID_ARGUMENT` error is returned.
        int32 page_size = 2;
        Returns:
        This builder for chaining.

      • getPageToken

        public String getPageToken()
         A page token
 [ListDocumentsResponse.next_page_token][google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token],
 received from a previous
 [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT` error is returned.
        string page_token = 3;
        Specified by:
        getPageToken in interface ListDocumentsRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         A page token
 [ListDocumentsResponse.next_page_token][google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token],
 received from a previous
 [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT` error is returned.
        string page_token = 3;
        Specified by:
        getPageTokenBytes in interface ListDocumentsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • setPageToken

        public ListDocumentsRequest.Builder setPageToken​(String value)
         A page token
 [ListDocumentsResponse.next_page_token][google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token],
 received from a previous
 [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT` error is returned.
        string page_token = 3;
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.

      • clearPageToken

        public ListDocumentsRequest.Builder clearPageToken()
         A page token
 [ListDocumentsResponse.next_page_token][google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token],
 received from a previous
 [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT` error is returned.
        string page_token = 3;
        Returns:
        This builder for chaining.

      • setPageTokenBytes

        public ListDocumentsRequest.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         A page token
 [ListDocumentsResponse.next_page_token][google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token],
 received from a previous
 [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT` error is returned.
        string page_token = 3;
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

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

      • mergeUnknownFields

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