Package com.google.cloud.discoveryengine.v1beta

Class AdvancedCompleteQueryRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest
All Implemented Interfaces:
AdvancedCompleteQueryRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class AdvancedCompleteQueryRequest extends com.google.protobuf.GeneratedMessage implements AdvancedCompleteQueryRequestOrBuilder
 Request message for
 [CompletionService.AdvancedCompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.AdvancedCompleteQuery]
 method.
 .
Protobuf type google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest
See Also:

  • Field Details

    • COMPLETION_CONFIG_FIELD_NUMBER

      public static final int COMPLETION_CONFIG_FIELD_NUMBER
      See Also:

    • QUERY_FIELD_NUMBER

      public static final int QUERY_FIELD_NUMBER
      See Also:

    • QUERY_MODEL_FIELD_NUMBER

      public static final int QUERY_MODEL_FIELD_NUMBER
      See Also:

    • USER_PSEUDO_ID_FIELD_NUMBER

      public static final int USER_PSEUDO_ID_FIELD_NUMBER
      See Also:

    • USER_INFO_FIELD_NUMBER

      public static final int USER_INFO_FIELD_NUMBER
      See Also:

    • INCLUDE_TAIL_SUGGESTIONS_FIELD_NUMBER

      public static final int INCLUDE_TAIL_SUGGESTIONS_FIELD_NUMBER
      See Also:

    • BOOST_SPEC_FIELD_NUMBER

      public static final int BOOST_SPEC_FIELD_NUMBER
      See Also:

    • SUGGESTION_TYPES_FIELD_NUMBER

      public static final int SUGGESTION_TYPES_FIELD_NUMBER
      See Also:

  • 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

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

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

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

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

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

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

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

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

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

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static AdvancedCompleteQueryRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AdvancedCompleteQueryRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AdvancedCompleteQueryRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AdvancedCompleteQueryRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AdvancedCompleteQueryRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AdvancedCompleteQueryRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AdvancedCompleteQueryRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AdvancedCompleteQueryRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AdvancedCompleteQueryRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AdvancedCompleteQueryRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AdvancedCompleteQueryRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AdvancedCompleteQueryRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static AdvancedCompleteQueryRequest.Builder newBuilder()

    • newBuilder

      public static AdvancedCompleteQueryRequest.Builder newBuilder(AdvancedCompleteQueryRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected AdvancedCompleteQueryRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static AdvancedCompleteQueryRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<AdvancedCompleteQueryRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<AdvancedCompleteQueryRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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