- 0.72.0 (latest)
- 0.71.0
- 0.70.0
- 0.69.0
- 0.68.0
- 0.66.0
- 0.64.0
- 0.63.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static final class CompleteQueryRequest.Builder extends GeneratedMessageV3.Builder<CompleteQueryRequest.Builder> implements CompleteQueryRequestOrBuilderRequest message for CompletionService.CompleteQuery method.
Protobuf type google.cloud.discoveryengine.v1beta.CompleteQueryRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CompleteQueryRequest.BuilderImplements
CompleteQueryRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CompleteQueryRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
|
build()
public CompleteQueryRequest build()| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest |
|
buildPartial()
public CompleteQueryRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest |
|
clear()
public CompleteQueryRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
|
clearDataStore()
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) = { ... }
| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public CompleteQueryRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public CompleteQueryRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
|
clearQuery()
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];
| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
This builder for chaining. |
clearQueryModel()
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 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:
documentis the default model for regular dataStores.search-historyis the default model for IndustryVertical.SITE_SEARCH dataStores.
string query_model = 3;
| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
This builder for chaining. |
clearUserPseudoId()
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 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 |
CompleteQueryRequest.Builder |
This builder for chaining. |
clone()
public CompleteQueryRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
|
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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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()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 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:
documentis the default model for regular dataStores.search-historyis the default model for IndustryVertical.SITE_SEARCH dataStores.
string query_model = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The queryModel. |
getQueryModelBytes()
public 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 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:
documentis the default model for regular dataStores.search-historyis the default model for IndustryVertical.SITE_SEARCH dataStores.
string query_model = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(CompleteQueryRequest other)
public CompleteQueryRequest.Builder mergeFrom(CompleteQueryRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
CompleteQueryRequest |
| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public CompleteQueryRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public CompleteQueryRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CompleteQueryRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
|
setDataStore(String value)
public 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe dataStore to set. |
| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
This builder for chaining. |
setDataStoreBytes(ByteString value)
public CompleteQueryRequest.Builder setDataStoreBytes(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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for dataStore to set. |
| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public CompleteQueryRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
|
setQuery(String value)
public 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe query to set. |
| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
This builder for chaining. |
setQueryBytes(ByteString value)
public CompleteQueryRequest.Builder setQueryBytes(ByteString value)Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
string query = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for query to set. |
| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
This builder for chaining. |
setQueryModel(String value)
public 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 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:
documentis the default model for regular dataStores.search-historyis the default model for IndustryVertical.SITE_SEARCH dataStores.
string query_model = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe queryModel to set. |
| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
This builder for chaining. |
setQueryModelBytes(ByteString value)
public CompleteQueryRequest.Builder setQueryModelBytes(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 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:
documentis the default model for regular dataStores.search-historyis the default model for IndustryVertical.SITE_SEARCH dataStores.
string query_model = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for queryModel to set. |
| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CompleteQueryRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final CompleteQueryRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
|
setUserPseudoId(String value)
public 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 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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe userPseudoId to set. |
| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
This builder for chaining. |
setUserPseudoIdBytes(ByteString value)
public CompleteQueryRequest.Builder setUserPseudoIdBytes(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 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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for userPseudoId to set. |
| Returns | |
|---|---|
| Type | Description |
CompleteQueryRequest.Builder |
This builder for chaining. |