public static final class CompleteQueryRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder> implements CompleteQueryRequestOrBuilder
Request message for [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.CompleteQuery] method.Protobuf type
google.cloud.discoveryengine.v1beta.CompleteQueryRequest| Modifier and Type | Method and Description |
|---|---|
CompleteQueryRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
CompleteQueryRequest |
build() |
CompleteQueryRequest |
buildPartial() |
CompleteQueryRequest.Builder |
clear() |
CompleteQueryRequest.Builder |
clearDataStore()
Required.
|
CompleteQueryRequest.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
CompleteQueryRequest.Builder |
clearIncludeTailSuggestions()
Indicates if tail suggestions should be returned if there are no
suggestions that match the full query.
|
CompleteQueryRequest.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
CompleteQueryRequest.Builder |
clearQuery()
Required.
|
CompleteQueryRequest.Builder |
clearQueryModel()
Selects data model of query suggestions for serving.
|
CompleteQueryRequest.Builder |
clearUserPseudoId()
A unique identifier for tracking visitors.
|
CompleteQueryRequest.Builder |
clone() |
String |
getDataStore()
Required.
|
com.google.protobuf.ByteString |
getDataStoreBytes()
Required.
|
CompleteQueryRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
boolean |
getIncludeTailSuggestions()
Indicates if tail suggestions should be returned if there are no
suggestions that match the full query.
|
String |
getQuery()
Required.
|
com.google.protobuf.ByteString |
getQueryBytes()
Required.
|
String |
getQueryModel()
Selects data model of query suggestions for serving.
|
com.google.protobuf.ByteString |
getQueryModelBytes()
Selects data model of query suggestions for serving.
|
String |
getUserPseudoId()
A unique identifier for tracking visitors.
|
com.google.protobuf.ByteString |
getUserPseudoIdBytes()
A unique identifier for tracking visitors.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
CompleteQueryRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
CompleteQueryRequest.Builder |
mergeFrom(CompleteQueryRequest other) |
CompleteQueryRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
CompleteQueryRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
CompleteQueryRequest.Builder |
setDataStore(String value)
Required.
|
CompleteQueryRequest.Builder |
setDataStoreBytes(com.google.protobuf.ByteString value)
Required.
|
CompleteQueryRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
CompleteQueryRequest.Builder |
setIncludeTailSuggestions(boolean value)
Indicates if tail suggestions should be returned if there are no
suggestions that match the full query.
|
CompleteQueryRequest.Builder |
setQuery(String value)
Required.
|
CompleteQueryRequest.Builder |
setQueryBytes(com.google.protobuf.ByteString value)
Required.
|
CompleteQueryRequest.Builder |
setQueryModel(String value)
Selects data model of query suggestions for serving.
|
CompleteQueryRequest.Builder |
setQueryModelBytes(com.google.protobuf.ByteString value)
Selects data model of query suggestions for serving.
|
CompleteQueryRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
CompleteQueryRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
CompleteQueryRequest.Builder |
setUserPseudoId(String value)
A unique identifier for tracking visitors.
|
CompleteQueryRequest.Builder |
setUserPseudoIdBytes(com.google.protobuf.ByteString value)
A unique identifier for tracking visitors.
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public CompleteQueryRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public CompleteQueryRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic CompleteQueryRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic CompleteQueryRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic CompleteQueryRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public CompleteQueryRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public CompleteQueryRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public CompleteQueryRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public CompleteQueryRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public CompleteQueryRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public CompleteQueryRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<CompleteQueryRequest.Builder>public CompleteQueryRequest.Builder mergeFrom(CompleteQueryRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public CompleteQueryRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<CompleteQueryRequest.Builder>IOExceptionpublic 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) = { ... }
getDataStore in interface CompleteQueryRequestOrBuilderpublic 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) = { ... }
getDataStoreBytes in interface CompleteQueryRequestOrBuilderpublic 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) = { ... }
value - The dataStore to set.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) = { ... }
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) = { ... }
value - The bytes for dataStore to set.public String getQuery()
Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
string query = 2 [(.google.api.field_behavior) = REQUIRED];getQuery in interface CompleteQueryRequestOrBuilderpublic 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];getQueryBytes in interface CompleteQueryRequestOrBuilderpublic 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];value - The query to set.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];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];value - The bytes for query to set.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.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 [IndustryVertical.SITE_SEARCH][] dataStores.
string query_model = 3;getQueryModel in interface CompleteQueryRequestOrBuilderpublic 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.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 [IndustryVertical.SITE_SEARCH][] dataStores.
string query_model = 3;getQueryModelBytes in interface CompleteQueryRequestOrBuilderpublic 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.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 [IndustryVertical.SITE_SEARCH][] dataStores.
string query_model = 3;value - The queryModel to set.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.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 [IndustryVertical.SITE_SEARCH][] dataStores.
string query_model = 3;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.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 [IndustryVertical.SITE_SEARCH][] dataStores.
string query_model = 3;value - The bytes for queryModel to set.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;getUserPseudoId in interface CompleteQueryRequestOrBuilderpublic 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;getUserPseudoIdBytes in interface CompleteQueryRequestOrBuilderpublic 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.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;value - The userPseudoId to set.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.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;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.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;value - The bytes for userPseudoId to set.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;getIncludeTailSuggestions in interface CompleteQueryRequestOrBuilderpublic 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;value - The includeTailSuggestions to set.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;public final CompleteQueryRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>public final CompleteQueryRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<CompleteQueryRequest.Builder>Copyright © 2024 Google LLC. All rights reserved.