Package com.google.cloud.discoveryengine.v1beta

Class CompleteQueryRequest

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CompleteQueryRequest.Builder
    Request message for [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] method.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DATA_STORE_FIELD_NUMBER
     
    static final int
    INCLUDE_TAIL_SUGGESTIONS_FIELD_NUMBER
     
    static final int
    QUERY_FIELD_NUMBER
     
    static final int
    QUERY_MODEL_FIELD_NUMBER
     
    static final int
    USER_PSEUDO_ID_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getDataStore()
    Required.
    com.google.protobuf.ByteString
    getDataStoreBytes()
    Required.
    static CompleteQueryRequest
    getDefaultInstance()
     
    CompleteQueryRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    boolean
    getIncludeTailSuggestions()
    Indicates if tail suggestions should be returned if there are no suggestions that match the full query.
    com.google.protobuf.Parser<CompleteQueryRequest>
    getParserForType()
     
    String
    getQuery()
    Required.
    com.google.protobuf.ByteString
    getQueryBytes()
    Required.
    String
    getQueryModel()
    Specifies the autocomplete data model.
    com.google.protobuf.ByteString
    getQueryModelBytes()
    Specifies the autocomplete data model.
    int
    getSerializedSize()
     
    String
    getUserPseudoId()
    A unique identifier for tracking visitors.
    com.google.protobuf.ByteString
    getUserPseudoIdBytes()
    A unique identifier for tracking visitors.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static CompleteQueryRequest.Builder
    newBuilder()
     
    static CompleteQueryRequest.Builder
    newBuilder(CompleteQueryRequest prototype)
     
    CompleteQueryRequest.Builder
    newBuilderForType()
     
    protected CompleteQueryRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static CompleteQueryRequest
    parseDelimitedFrom(InputStream input)
     
    static CompleteQueryRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CompleteQueryRequest
    parseFrom(byte[] data)
     
    static CompleteQueryRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CompleteQueryRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static CompleteQueryRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CompleteQueryRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static CompleteQueryRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CompleteQueryRequest
    parseFrom(InputStream input)
     
    static CompleteQueryRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CompleteQueryRequest
    parseFrom(ByteBuffer data)
     
    static CompleteQueryRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<CompleteQueryRequest>
    parser()
     
    CompleteQueryRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • DATA_STORE_FIELD_NUMBER

      public static final int DATA_STORE_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:

    • INCLUDE_TAIL_SUGGESTIONS_FIELD_NUMBER

      public static final int INCLUDE_TAIL_SUGGESTIONS_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

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

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

    • 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 CompleteQueryRequestOrBuilder
      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 CompleteQueryRequestOrBuilder
      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
 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.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
 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
      string user_pseudo_id = 4;
      Specified by:
      getUserPseudoIdBytes in interface CompleteQueryRequestOrBuilder
      Returns:
      The bytes for userPseudoId.

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

    • 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 CompleteQueryRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static CompleteQueryRequest.Builder newBuilder()

    • newBuilder

      public static CompleteQueryRequest.Builder newBuilder(CompleteQueryRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static CompleteQueryRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<CompleteQueryRequest> 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 CompleteQueryRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder