Package com.google.cloud.discoveryengine.v1beta

Class AdvancedCompleteQueryRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<AdvancedCompleteQueryRequest.Builder>
com.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.Builder
All Implemented Interfaces:
AdvancedCompleteQueryRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
AdvancedCompleteQueryRequest
public static final class AdvancedCompleteQueryRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<AdvancedCompleteQueryRequest.Builder> implements AdvancedCompleteQueryRequestOrBuilder
 Request message for
 [CompletionService.AdvancedCompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.AdvancedCompleteQuery]
 method.
 .
Protobuf type google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • clear

      public AdvancedCompleteQueryRequest.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.GeneratedMessage.Builder<AdvancedCompleteQueryRequest.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.GeneratedMessage.Builder<AdvancedCompleteQueryRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public AdvancedCompleteQueryRequest.Builder mergeFrom(AdvancedCompleteQueryRequest other)

    • isInitialized

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

    • mergeFrom

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

    • getCompletionConfig

      public String getCompletionConfig()
       Required. The completion_config of the parent dataStore or engine resource
 name for which the completion is performed, such as
 `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig`
 `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.
      string completion_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getCompletionConfig in interface AdvancedCompleteQueryRequestOrBuilder
      Returns:
      The completionConfig.

    • getCompletionConfigBytes

      public com.google.protobuf.ByteString getCompletionConfigBytes()
       Required. The completion_config of the parent dataStore or engine resource
 name for which the completion is performed, such as
 `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig`
 `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.
      string completion_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getCompletionConfigBytes in interface AdvancedCompleteQueryRequestOrBuilder
      Returns:
      The bytes for completionConfig.

    • setCompletionConfig

      public AdvancedCompleteQueryRequest.Builder setCompletionConfig(String value)
       Required. The completion_config of the parent dataStore or engine resource
 name for which the completion is performed, such as
 `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig`
 `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.
      string completion_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The completionConfig to set.
      Returns:
      This builder for chaining.

    • clearCompletionConfig

      public AdvancedCompleteQueryRequest.Builder clearCompletionConfig()
       Required. The completion_config of the parent dataStore or engine resource
 name for which the completion is performed, such as
 `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig`
 `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.
      string completion_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setCompletionConfigBytes

      public AdvancedCompleteQueryRequest.Builder setCompletionConfigBytes(com.google.protobuf.ByteString value)
       Required. The completion_config of the parent dataStore or engine resource
 name for which the completion is performed, such as
 `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig`
 `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.
      string completion_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for completionConfig to set.
      Returns:
      This builder for chaining.

    • getQuery

      public String getQuery()
       Required. The typeahead input used to fetch suggestions. Maximum length is
 128 characters.

 The query can not be empty for most of the suggestion types. If it is
 empty, an `INVALID_ARGUMENT` error is returned. The exception is when the
 suggestion_types contains only the type `RECENT_SEARCH`, the query can
 be an empty string. The is called "zero prefix" feature, which returns
 user's recently searched queries given the empty query.
      string query = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQuery in interface AdvancedCompleteQueryRequestOrBuilder
      Returns:
      The query.

    • getQueryBytes

      public com.google.protobuf.ByteString getQueryBytes()
       Required. The typeahead input used to fetch suggestions. Maximum length is
 128 characters.

 The query can not be empty for most of the suggestion types. If it is
 empty, an `INVALID_ARGUMENT` error is returned. The exception is when the
 suggestion_types contains only the type `RECENT_SEARCH`, the query can
 be an empty string. The is called "zero prefix" feature, which returns
 user's recently searched queries given the empty query.
      string query = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQueryBytes in interface AdvancedCompleteQueryRequestOrBuilder
      Returns:
      The bytes for query.

    • setQuery

      public AdvancedCompleteQueryRequest.Builder setQuery(String value)
       Required. The typeahead input used to fetch suggestions. Maximum length is
 128 characters.

 The query can not be empty for most of the suggestion types. If it is
 empty, an `INVALID_ARGUMENT` error is returned. The exception is when the
 suggestion_types contains only the type `RECENT_SEARCH`, the query can
 be an empty string. The is called "zero prefix" feature, which returns
 user's recently searched queries given the empty query.
      string query = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The query to set.
      Returns:
      This builder for chaining.

    • clearQuery

      public AdvancedCompleteQueryRequest.Builder clearQuery()
       Required. The typeahead input used to fetch suggestions. Maximum length is
 128 characters.

 The query can not be empty for most of the suggestion types. If it is
 empty, an `INVALID_ARGUMENT` error is returned. The exception is when the
 suggestion_types contains only the type `RECENT_SEARCH`, the query can
 be an empty string. The is called "zero prefix" feature, which returns
 user's recently searched queries given the empty query.
      string query = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setQueryBytes

      public AdvancedCompleteQueryRequest.Builder setQueryBytes(com.google.protobuf.ByteString value)
       Required. The typeahead input used to fetch suggestions. Maximum length is
 128 characters.

 The query can not be empty for most of the suggestion types. If it is
 empty, an `INVALID_ARGUMENT` error is returned. The exception is when the
 suggestion_types contains only the type `RECENT_SEARCH`, the query can
 be an empty string. The is called "zero prefix" feature, which returns
 user's recently searched queries given the empty query.
      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()
       Specifies the autocomplete data model. This overrides any model specified
 in the Configuration > Autocomplete section of the Cloud console. 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.v1beta.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 site search dataStores.
      string query_model = 3;
      Specified by:
      getQueryModel in interface AdvancedCompleteQueryRequestOrBuilder
      Returns:
      The queryModel.

    • getQueryModelBytes

      public com.google.protobuf.ByteString getQueryModelBytes()
       Specifies the autocomplete data model. This overrides any model specified
 in the Configuration > Autocomplete section of the Cloud console. 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.v1beta.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 site search dataStores.
      string query_model = 3;
      Specified by:
      getQueryModelBytes in interface AdvancedCompleteQueryRequestOrBuilder
      Returns:
      The bytes for queryModel.

    • setQueryModel

      public AdvancedCompleteQueryRequest.Builder setQueryModel(String value)
       Specifies the autocomplete data model. This overrides any model specified
 in the Configuration > Autocomplete section of the Cloud console. 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.v1beta.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 site search dataStores.
      string query_model = 3;
      Parameters:
      value - The queryModel to set.
      Returns:
      This builder for chaining.

    • clearQueryModel

      public AdvancedCompleteQueryRequest.Builder clearQueryModel()
       Specifies the autocomplete data model. This overrides any model specified
 in the Configuration > Autocomplete section of the Cloud console. 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.v1beta.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 site search dataStores.
      string query_model = 3;
      Returns:
      This builder for chaining.

    • setQueryModelBytes

      public AdvancedCompleteQueryRequest.Builder setQueryModelBytes(com.google.protobuf.ByteString value)
       Specifies the autocomplete data model. This overrides any model specified
 in the Configuration > Autocomplete section of the Cloud console. 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.v1beta.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 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.v1beta.UserEvent.user_pseudo_id]
 and
 [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id].

 The field must be a UTF-8 encoded string with a length limit of 128
      string user_pseudo_id = 4;
      Specified by:
      getUserPseudoId in interface AdvancedCompleteQueryRequestOrBuilder
      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.v1beta.UserEvent.user_pseudo_id]
 and
 [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id].

 The field must be a UTF-8 encoded string with a length limit of 128
      string user_pseudo_id = 4;
      Specified by:
      getUserPseudoIdBytes in interface AdvancedCompleteQueryRequestOrBuilder
      Returns:
      The bytes for userPseudoId.

    • setUserPseudoId

      public AdvancedCompleteQueryRequest.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.v1beta.UserEvent.user_pseudo_id]
 and
 [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id].

 The field must be a UTF-8 encoded string with a length limit of 128
      string user_pseudo_id = 4;
      Parameters:
      value - The userPseudoId to set.
      Returns:
      This builder for chaining.

    • clearUserPseudoId

      public AdvancedCompleteQueryRequest.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.v1beta.UserEvent.user_pseudo_id]
 and
 [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id].

 The field must be a UTF-8 encoded string with a length limit of 128
      string user_pseudo_id = 4;
      Returns:
      This builder for chaining.

    • setUserPseudoIdBytes

      public AdvancedCompleteQueryRequest.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.v1beta.UserEvent.user_pseudo_id]
 and
 [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id].

 The field must be a UTF-8 encoded string with a length limit of 128
      string user_pseudo_id = 4;
      Parameters:
      value - The bytes for userPseudoId to set.
      Returns:
      This builder for chaining.

    • hasUserInfo

      public boolean hasUserInfo()
       Optional. Information about the end user.

 This should be the same identifier information as
 [UserEvent.user_info][google.cloud.discoveryengine.v1beta.UserEvent.user_info]
 and
 [SearchRequest.user_info][google.cloud.discoveryengine.v1beta.SearchRequest.user_info].
      .google.cloud.discoveryengine.v1beta.UserInfo user_info = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasUserInfo in interface AdvancedCompleteQueryRequestOrBuilder
      Returns:
      Whether the userInfo field is set.

    • getUserInfo

      public UserInfo getUserInfo()
       Optional. Information about the end user.

 This should be the same identifier information as
 [UserEvent.user_info][google.cloud.discoveryengine.v1beta.UserEvent.user_info]
 and
 [SearchRequest.user_info][google.cloud.discoveryengine.v1beta.SearchRequest.user_info].
      .google.cloud.discoveryengine.v1beta.UserInfo user_info = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUserInfo in interface AdvancedCompleteQueryRequestOrBuilder
      Returns:
      The userInfo.

    • setUserInfo

      public AdvancedCompleteQueryRequest.Builder setUserInfo(UserInfo value)
       Optional. Information about the end user.

 This should be the same identifier information as
 [UserEvent.user_info][google.cloud.discoveryengine.v1beta.UserEvent.user_info]
 and
 [SearchRequest.user_info][google.cloud.discoveryengine.v1beta.SearchRequest.user_info].
      .google.cloud.discoveryengine.v1beta.UserInfo user_info = 9 [(.google.api.field_behavior) = OPTIONAL];

    • setUserInfo

      public AdvancedCompleteQueryRequest.Builder setUserInfo(UserInfo.Builder builderForValue)
       Optional. Information about the end user.

 This should be the same identifier information as
 [UserEvent.user_info][google.cloud.discoveryengine.v1beta.UserEvent.user_info]
 and
 [SearchRequest.user_info][google.cloud.discoveryengine.v1beta.SearchRequest.user_info].
      .google.cloud.discoveryengine.v1beta.UserInfo user_info = 9 [(.google.api.field_behavior) = OPTIONAL];

    • mergeUserInfo

      public AdvancedCompleteQueryRequest.Builder mergeUserInfo(UserInfo value)
       Optional. Information about the end user.

 This should be the same identifier information as
 [UserEvent.user_info][google.cloud.discoveryengine.v1beta.UserEvent.user_info]
 and
 [SearchRequest.user_info][google.cloud.discoveryengine.v1beta.SearchRequest.user_info].
      .google.cloud.discoveryengine.v1beta.UserInfo user_info = 9 [(.google.api.field_behavior) = OPTIONAL];

    • clearUserInfo

      public AdvancedCompleteQueryRequest.Builder clearUserInfo()
       Optional. Information about the end user.

 This should be the same identifier information as
 [UserEvent.user_info][google.cloud.discoveryengine.v1beta.UserEvent.user_info]
 and
 [SearchRequest.user_info][google.cloud.discoveryengine.v1beta.SearchRequest.user_info].
      .google.cloud.discoveryengine.v1beta.UserInfo user_info = 9 [(.google.api.field_behavior) = OPTIONAL];

    • getUserInfoBuilder

      public UserInfo.Builder getUserInfoBuilder()
       Optional. Information about the end user.

 This should be the same identifier information as
 [UserEvent.user_info][google.cloud.discoveryengine.v1beta.UserEvent.user_info]
 and
 [SearchRequest.user_info][google.cloud.discoveryengine.v1beta.SearchRequest.user_info].
      .google.cloud.discoveryengine.v1beta.UserInfo user_info = 9 [(.google.api.field_behavior) = OPTIONAL];

    • getUserInfoOrBuilder

      public UserInfoOrBuilder getUserInfoOrBuilder()
       Optional. Information about the end user.

 This should be the same identifier information as
 [UserEvent.user_info][google.cloud.discoveryengine.v1beta.UserEvent.user_info]
 and
 [SearchRequest.user_info][google.cloud.discoveryengine.v1beta.SearchRequest.user_info].
      .google.cloud.discoveryengine.v1beta.UserInfo user_info = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUserInfoOrBuilder in interface AdvancedCompleteQueryRequestOrBuilder

    • 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 AdvancedCompleteQueryRequestOrBuilder
      Returns:
      The includeTailSuggestions.

    • setIncludeTailSuggestions

      public AdvancedCompleteQueryRequest.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 AdvancedCompleteQueryRequest.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.

    • hasBoostSpec

      public boolean hasBoostSpec()
       Optional. Specification to boost suggestions matching the condition.
      .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasBoostSpec in interface AdvancedCompleteQueryRequestOrBuilder
      Returns:
      Whether the boostSpec field is set.

    • getBoostSpec

      public AdvancedCompleteQueryRequest.BoostSpec getBoostSpec()
       Optional. Specification to boost suggestions matching the condition.
      .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBoostSpec in interface AdvancedCompleteQueryRequestOrBuilder
      Returns:
      The boostSpec.

    • setBoostSpec

      public AdvancedCompleteQueryRequest.Builder setBoostSpec(AdvancedCompleteQueryRequest.BoostSpec value)
       Optional. Specification to boost suggestions matching the condition.
      .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

    • setBoostSpec

      public AdvancedCompleteQueryRequest.Builder setBoostSpec(AdvancedCompleteQueryRequest.BoostSpec.Builder builderForValue)
       Optional. Specification to boost suggestions matching the condition.
      .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

    • mergeBoostSpec

      public AdvancedCompleteQueryRequest.Builder mergeBoostSpec(AdvancedCompleteQueryRequest.BoostSpec value)
       Optional. Specification to boost suggestions matching the condition.
      .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

    • clearBoostSpec

      public AdvancedCompleteQueryRequest.Builder clearBoostSpec()
       Optional. Specification to boost suggestions matching the condition.
      .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getBoostSpecBuilder

      public AdvancedCompleteQueryRequest.BoostSpec.Builder getBoostSpecBuilder()
       Optional. Specification to boost suggestions matching the condition.
      .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getBoostSpecOrBuilder

      public AdvancedCompleteQueryRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()
       Optional. Specification to boost suggestions matching the condition.
      .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getBoostSpecOrBuilder in interface AdvancedCompleteQueryRequestOrBuilder

    • getSuggestionTypesList

      public List<AdvancedCompleteQueryRequest.SuggestionType> getSuggestionTypesList()
       Optional. Suggestion types to return. If empty or unspecified, query
 suggestions are returned. Only one suggestion type is supported at the
 moment.
      repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSuggestionTypesList in interface AdvancedCompleteQueryRequestOrBuilder
      Returns:
      A list containing the suggestionTypes.

    • getSuggestionTypesCount

      public int getSuggestionTypesCount()
       Optional. Suggestion types to return. If empty or unspecified, query
 suggestions are returned. Only one suggestion type is supported at the
 moment.
      repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSuggestionTypesCount in interface AdvancedCompleteQueryRequestOrBuilder
      Returns:
      The count of suggestionTypes.

    • getSuggestionTypes

      public AdvancedCompleteQueryRequest.SuggestionType getSuggestionTypes(int index)
       Optional. Suggestion types to return. If empty or unspecified, query
 suggestions are returned. Only one suggestion type is supported at the
 moment.
      repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSuggestionTypes in interface AdvancedCompleteQueryRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The suggestionTypes at the given index.

    • setSuggestionTypes

      public AdvancedCompleteQueryRequest.Builder setSuggestionTypes(int index, AdvancedCompleteQueryRequest.SuggestionType value)
       Optional. Suggestion types to return. If empty or unspecified, query
 suggestions are returned. Only one suggestion type is supported at the
 moment.
      repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index to set the value at.
      value - The suggestionTypes to set.
      Returns:
      This builder for chaining.

    • addSuggestionTypes

      public AdvancedCompleteQueryRequest.Builder addSuggestionTypes(AdvancedCompleteQueryRequest.SuggestionType value)
       Optional. Suggestion types to return. If empty or unspecified, query
 suggestions are returned. Only one suggestion type is supported at the
 moment.
      repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The suggestionTypes to add.
      Returns:
      This builder for chaining.

    • addAllSuggestionTypes

      public AdvancedCompleteQueryRequest.Builder addAllSuggestionTypes(Iterable<? extends AdvancedCompleteQueryRequest.SuggestionType> values)
       Optional. Suggestion types to return. If empty or unspecified, query
 suggestions are returned. Only one suggestion type is supported at the
 moment.
      repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      values - The suggestionTypes to add.
      Returns:
      This builder for chaining.

    • clearSuggestionTypes

      public AdvancedCompleteQueryRequest.Builder clearSuggestionTypes()
       Optional. Suggestion types to return. If empty or unspecified, query
 suggestions are returned. Only one suggestion type is supported at the
 moment.
      repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • getSuggestionTypesValueList

      public List<Integer> getSuggestionTypesValueList()
       Optional. Suggestion types to return. If empty or unspecified, query
 suggestions are returned. Only one suggestion type is supported at the
 moment.
      repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSuggestionTypesValueList in interface AdvancedCompleteQueryRequestOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for suggestionTypes.

    • getSuggestionTypesValue

      public int getSuggestionTypesValue(int index)
       Optional. Suggestion types to return. If empty or unspecified, query
 suggestions are returned. Only one suggestion type is supported at the
 moment.
      repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSuggestionTypesValue in interface AdvancedCompleteQueryRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of suggestionTypes at the given index.

    • setSuggestionTypesValue

      public AdvancedCompleteQueryRequest.Builder setSuggestionTypesValue(int index, int value)
       Optional. Suggestion types to return. If empty or unspecified, query
 suggestions are returned. Only one suggestion type is supported at the
 moment.
      repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index to set the value at.
      value - The enum numeric value on the wire for suggestionTypes to set.
      Returns:
      This builder for chaining.

    • addSuggestionTypesValue

      public AdvancedCompleteQueryRequest.Builder addSuggestionTypesValue(int value)
       Optional. Suggestion types to return. If empty or unspecified, query
 suggestions are returned. Only one suggestion type is supported at the
 moment.
      repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The enum numeric value on the wire for suggestionTypes to add.
      Returns:
      This builder for chaining.

    • addAllSuggestionTypesValue

      public AdvancedCompleteQueryRequest.Builder addAllSuggestionTypesValue(Iterable<Integer> values)
       Optional. Suggestion types to return. If empty or unspecified, query
 suggestions are returned. Only one suggestion type is supported at the
 moment.
      repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      values - The enum numeric values on the wire for suggestionTypes to add.
      Returns:
      This builder for chaining.