Package com.google.cloud.discoveryengine.v1

Class CompleteQueryRequest.Builder

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

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

      • clear

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • isInitialized

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

      • mergeFrom

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

      • getDataStore

        public String getDataStore()
         Required. The parent data store resource name for which the completion is
 performed, such as
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
        string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getDataStore in interface CompleteQueryRequestOrBuilder
        Returns:
        The dataStore.

      • getDataStoreBytes

        public com.google.protobuf.ByteString getDataStoreBytes()
         Required. The parent data store resource name for which the completion is
 performed, such as
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
        string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getDataStoreBytes in interface CompleteQueryRequestOrBuilder
        Returns:
        The bytes for dataStore.

      • setDataStore

        public CompleteQueryRequest.Builder setDataStore​(String value)
         Required. The parent data store resource name for which the completion is
 performed, such as
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
        string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The dataStore to set.
        Returns:
        This builder for chaining.

      • clearDataStore

        public CompleteQueryRequest.Builder clearDataStore()
         Required. The parent data store resource name for which the completion is
 performed, such as
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
        string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setDataStoreBytes

        public CompleteQueryRequest.Builder setDataStoreBytes​(com.google.protobuf.ByteString value)
         Required. The parent data store resource name for which the completion is
 performed, such as
 `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
        string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for dataStore to set.
        Returns:
        This builder for chaining.

      • getQuery

        public String getQuery()
         Required. The typeahead input used to fetch suggestions. Maximum length is
 128 characters.
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getQuery in interface CompleteQueryRequestOrBuilder
        Returns:
        The query.

      • getQueryBytes

        public com.google.protobuf.ByteString getQueryBytes()
         Required. The typeahead input used to fetch suggestions. Maximum length is
 128 characters.
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getQueryBytes in interface CompleteQueryRequestOrBuilder
        Returns:
        The bytes for query.

      • setQuery

        public CompleteQueryRequest.Builder setQuery​(String value)
         Required. The typeahead input used to fetch suggestions. Maximum length is
 128 characters.
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The query to set.
        Returns:
        This builder for chaining.

      • clearQuery

        public CompleteQueryRequest.Builder clearQuery()
         Required. The typeahead input used to fetch suggestions. Maximum length is
 128 characters.
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setQueryBytes

        public CompleteQueryRequest.Builder setQueryBytes​(com.google.protobuf.ByteString value)
         Required. The typeahead input used to fetch suggestions. Maximum length is
 128 characters.
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for query to set.
        Returns:
        This builder for chaining.

      • getQueryModel

        public String getQueryModel()
         Selects data model of query suggestions for serving. Currently supported
 values:

 * `document` - Using suggestions generated from user-imported documents.
 * `search-history` - Using suggestions generated from the past history of
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 API calls. Do not use it when there is no traffic for Search API.
 * `user-event` - Using suggestions generated from user-imported search
 events.
 * `document-completable` - Using suggestions taken directly from
 user-imported document fields marked as completable.

 Default values:

 * `document` is the default model for regular dataStores.
 * `search-history` is the default model for
 [IndustryVertical.SITE_SEARCH][] dataStores.
        string query_model = 3;
        Specified by:
        getQueryModel in interface CompleteQueryRequestOrBuilder
        Returns:
        The queryModel.

      • getQueryModelBytes

        public com.google.protobuf.ByteString getQueryModelBytes()
         Selects data model of query suggestions for serving. Currently supported
 values:

 * `document` - Using suggestions generated from user-imported documents.
 * `search-history` - Using suggestions generated from the past history of
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 API calls. Do not use it when there is no traffic for Search API.
 * `user-event` - Using suggestions generated from user-imported search
 events.
 * `document-completable` - Using suggestions taken directly from
 user-imported document fields marked as completable.

 Default values:

 * `document` is the default model for regular dataStores.
 * `search-history` is the default model for
 [IndustryVertical.SITE_SEARCH][] dataStores.
        string query_model = 3;
        Specified by:
        getQueryModelBytes in interface CompleteQueryRequestOrBuilder
        Returns:
        The bytes for queryModel.

      • setQueryModel

        public CompleteQueryRequest.Builder setQueryModel​(String value)
         Selects data model of query suggestions for serving. Currently supported
 values:

 * `document` - Using suggestions generated from user-imported documents.
 * `search-history` - Using suggestions generated from the past history of
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 API calls. Do not use it when there is no traffic for Search API.
 * `user-event` - Using suggestions generated from user-imported search
 events.
 * `document-completable` - Using suggestions taken directly from
 user-imported document fields marked as completable.

 Default values:

 * `document` is the default model for regular dataStores.
 * `search-history` is the default model for
 [IndustryVertical.SITE_SEARCH][] dataStores.
        string query_model = 3;
        Parameters:
        value - The queryModel to set.
        Returns:
        This builder for chaining.

      • clearQueryModel

        public CompleteQueryRequest.Builder clearQueryModel()
         Selects data model of query suggestions for serving. Currently supported
 values:

 * `document` - Using suggestions generated from user-imported documents.
 * `search-history` - Using suggestions generated from the past history of
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 API calls. Do not use it when there is no traffic for Search API.
 * `user-event` - Using suggestions generated from user-imported search
 events.
 * `document-completable` - Using suggestions taken directly from
 user-imported document fields marked as completable.

 Default values:

 * `document` is the default model for regular dataStores.
 * `search-history` is the default model for
 [IndustryVertical.SITE_SEARCH][] dataStores.
        string query_model = 3;
        Returns:
        This builder for chaining.

      • setQueryModelBytes

        public CompleteQueryRequest.Builder setQueryModelBytes​(com.google.protobuf.ByteString value)
         Selects data model of query suggestions for serving. Currently supported
 values:

 * `document` - Using suggestions generated from user-imported documents.
 * `search-history` - Using suggestions generated from the past history of
 [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
 API calls. Do not use it when there is no traffic for Search API.
 * `user-event` - Using suggestions generated from user-imported search
 events.
 * `document-completable` - Using suggestions taken directly from
 user-imported document fields marked as completable.

 Default values:

 * `document` is the default model for regular dataStores.
 * `search-history` is the default model for
 [IndustryVertical.SITE_SEARCH][] dataStores.
        string query_model = 3;
        Parameters:
        value - The bytes for queryModel to set.
        Returns:
        This builder for chaining.

      • getUserPseudoId

        public String getUserPseudoId()
         A unique identifier for tracking visitors. For example, this could be
 implemented with an HTTP cookie, which should be able to uniquely identify
 a visitor on a single device. This unique identifier should not change if
 the visitor logs in or out of the website.

 This field should NOT have a fixed value such as `unknown_visitor`.

 This should be the same identifier as
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
 and
 [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1.SearchRequest.user_pseudo_id].

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
        string user_pseudo_id = 4;
        Specified by:
        getUserPseudoId in interface CompleteQueryRequestOrBuilder
        Returns:
        The userPseudoId.

      • getUserPseudoIdBytes

        public com.google.protobuf.ByteString getUserPseudoIdBytes()
         A unique identifier for tracking visitors. For example, this could be
 implemented with an HTTP cookie, which should be able to uniquely identify
 a visitor on a single device. This unique identifier should not change if
 the visitor logs in or out of the website.

 This field should NOT have a fixed value such as `unknown_visitor`.

 This should be the same identifier as
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
 and
 [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1.SearchRequest.user_pseudo_id].

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
        string user_pseudo_id = 4;
        Specified by:
        getUserPseudoIdBytes in interface CompleteQueryRequestOrBuilder
        Returns:
        The bytes for userPseudoId.

      • setUserPseudoId

        public CompleteQueryRequest.Builder setUserPseudoId​(String value)
         A unique identifier for tracking visitors. For example, this could be
 implemented with an HTTP cookie, which should be able to uniquely identify
 a visitor on a single device. This unique identifier should not change if
 the visitor logs in or out of the website.

 This field should NOT have a fixed value such as `unknown_visitor`.

 This should be the same identifier as
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
 and
 [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1.SearchRequest.user_pseudo_id].

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
        string user_pseudo_id = 4;
        Parameters:
        value - The userPseudoId to set.
        Returns:
        This builder for chaining.

      • clearUserPseudoId

        public CompleteQueryRequest.Builder clearUserPseudoId()
         A unique identifier for tracking visitors. For example, this could be
 implemented with an HTTP cookie, which should be able to uniquely identify
 a visitor on a single device. This unique identifier should not change if
 the visitor logs in or out of the website.

 This field should NOT have a fixed value such as `unknown_visitor`.

 This should be the same identifier as
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
 and
 [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1.SearchRequest.user_pseudo_id].

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
        string user_pseudo_id = 4;
        Returns:
        This builder for chaining.

      • setUserPseudoIdBytes

        public CompleteQueryRequest.Builder setUserPseudoIdBytes​(com.google.protobuf.ByteString value)
         A unique identifier for tracking visitors. For example, this could be
 implemented with an HTTP cookie, which should be able to uniquely identify
 a visitor on a single device. This unique identifier should not change if
 the visitor logs in or out of the website.

 This field should NOT have a fixed value such as `unknown_visitor`.

 This should be the same identifier as
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
 and
 [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1.SearchRequest.user_pseudo_id].

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
        string user_pseudo_id = 4;
        Parameters:
        value - The bytes for userPseudoId to set.
        Returns:
        This builder for chaining.

      • getIncludeTailSuggestions

        public boolean getIncludeTailSuggestions()
         Indicates if tail suggestions should be returned if there are no
 suggestions that match the full query. Even if set to true, if there are
 suggestions that match the full query, those are returned and no
 tail suggestions are returned.
        bool include_tail_suggestions = 5;
        Specified by:
        getIncludeTailSuggestions in interface CompleteQueryRequestOrBuilder
        Returns:
        The includeTailSuggestions.

      • setIncludeTailSuggestions

        public CompleteQueryRequest.Builder setIncludeTailSuggestions​(boolean value)
         Indicates if tail suggestions should be returned if there are no
 suggestions that match the full query. Even if set to true, if there are
 suggestions that match the full query, those are returned and no
 tail suggestions are returned.
        bool include_tail_suggestions = 5;
        Parameters:
        value - The includeTailSuggestions to set.
        Returns:
        This builder for chaining.

      • clearIncludeTailSuggestions

        public CompleteQueryRequest.Builder clearIncludeTailSuggestions()
         Indicates if tail suggestions should be returned if there are no
 suggestions that match the full query. Even if set to true, if there are
 suggestions that match the full query, those are returned and no
 tail suggestions are returned.
        bool include_tail_suggestions = 5;
        Returns:
        This builder for chaining.

      • setUnknownFields

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

      • mergeUnknownFields

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