Class CompleteQueryRequest (0.51.0)

public final class CompleteQueryRequest extends GeneratedMessageV3 implements CompleteQueryRequestOrBuilder

Request message for CompletionService.CompleteQuery method.

Protobuf type google.cloud.discoveryengine.v1beta.CompleteQueryRequest

Static Fields

DATA_STORE_FIELD_NUMBER

public static final int DATA_STORE_FIELD_NUMBER
Field Value
Type Description
int

INCLUDE_TAIL_SUGGESTIONS_FIELD_NUMBER

public static final int INCLUDE_TAIL_SUGGESTIONS_FIELD_NUMBER
Field Value
Type Description
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
Type Description
int

QUERY_MODEL_FIELD_NUMBER

public static final int QUERY_MODEL_FIELD_NUMBER
Field Value
Type Description
int

USER_PSEUDO_ID_FIELD_NUMBER

public static final int USER_PSEUDO_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CompleteQueryRequest getDefaultInstance()
Returns
Type Description
CompleteQueryRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CompleteQueryRequest.Builder newBuilder()
Returns
Type Description
CompleteQueryRequest.Builder

newBuilder(CompleteQueryRequest prototype)

public static CompleteQueryRequest.Builder newBuilder(CompleteQueryRequest prototype)
Parameter
Name Description
prototype CompleteQueryRequest
Returns
Type Description
CompleteQueryRequest.Builder

parseDelimitedFrom(InputStream input)

public static CompleteQueryRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CompleteQueryRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompleteQueryRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CompleteQueryRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CompleteQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompleteQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CompleteQueryRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CompleteQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompleteQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CompleteQueryRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CompleteQueryRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompleteQueryRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CompleteQueryRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CompleteQueryRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompleteQueryRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CompleteQueryRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CompleteQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CompleteQueryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompleteQueryRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CompleteQueryRequest> parser()
Returns
Type Description
Parser<CompleteQueryRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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) = { ... }

Returns
Type Description
String

The dataStore.

getDataStoreBytes()

public 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) = { ... }

Returns
Type Description
ByteString

The bytes for dataStore.

getDefaultInstanceForType()

public CompleteQueryRequest getDefaultInstanceForType()
Returns
Type Description
CompleteQueryRequest

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;

Returns
Type Description
boolean

The includeTailSuggestions.

getParserForType()

public Parser<CompleteQueryRequest> getParserForType()
Returns
Type Description
Parser<CompleteQueryRequest>
Overrides

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];

Returns
Type Description
String

The query.

getQueryBytes()

public ByteString getQueryBytes()

Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.

string query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

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 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
Type Description
String

The queryModel.

getQueryModelBytes()

public 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 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
Type Description
ByteString

The bytes for queryModel.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 and 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
Type Description
String

The userPseudoId.

getUserPseudoIdBytes()

public 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 and 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
Type Description
ByteString

The bytes for userPseudoId.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CompleteQueryRequest.Builder newBuilderForType()
Returns
Type Description
CompleteQueryRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CompleteQueryRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CompleteQueryRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CompleteQueryRequest.Builder toBuilder()
Returns
Type Description
CompleteQueryRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException