- 2.64.0 (latest)
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public static final class ConversationalSearchRequest.Builder extends GeneratedMessageV3.Builder<ConversationalSearchRequest.Builder> implements ConversationalSearchRequestOrBuilderRequest message for ConversationalSearchService.ConversationalSearch method.
Protobuf type google.cloud.retail.v2alpha.ConversationalSearchRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ConversationalSearchRequest.BuilderImplements
ConversationalSearchRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllPageCategories(Iterable<String> values)
public ConversationalSearchRequest.Builder addAllPageCategories(Iterable<String> values)Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories;
To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).
Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The pageCategories to add. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
This builder for chaining. |
addPageCategories(String value)
public ConversationalSearchRequest.Builder addPageCategories(String value)Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories;
To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).
Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageCategories to add. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
This builder for chaining. |
addPageCategoriesBytes(ByteString value)
public ConversationalSearchRequest.Builder addPageCategoriesBytes(ByteString value)Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories;
To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).
Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the pageCategories to add. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ConversationalSearchRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
build()
public ConversationalSearchRequest build()| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest |
|
buildPartial()
public ConversationalSearchRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest |
|
clear()
public ConversationalSearchRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
clearBranch()
public ConversationalSearchRequest.Builder clearBranch() Required. The branch resource name, such as
projects/*/locations/global/catalogs/default_catalog/branches/0.
Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.
string branch = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
This builder for chaining. |
clearConversationId()
public ConversationalSearchRequest.Builder clearConversationId()Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id. For the initial request, this should be empty.
string conversation_id = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
This builder for chaining. |
clearConversationalFilteringSpec()
public ConversationalSearchRequest.Builder clearConversationalFilteringSpec()Optional. This field specifies all conversational filtering related parameters.
.google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec conversational_filtering_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ConversationalSearchRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public ConversationalSearchRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
clearPageCategories()
public ConversationalSearchRequest.Builder clearPageCategories()Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories;
To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).
Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
This builder for chaining. |
clearPlacement()
public ConversationalSearchRequest.Builder clearPlacement() Required. The resource name of the search engine placement, such as
projects/*/locations/global/catalogs/default_catalog/placements/default_search
or
projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config
This field is used to identify the serving config name and the set
of models that will be used to make the search.
string placement = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
This builder for chaining. |
clearQuery()
public ConversationalSearchRequest.Builder clearQuery()Optional. Raw search query to be searched for.
If this field is empty, the request is considered a category browsing request.
string query = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
This builder for chaining. |
clearSearchParams()
public ConversationalSearchRequest.Builder clearSearchParams()Optional. Search parameters.
.google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams search_params = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
clearUserInfo()
public ConversationalSearchRequest.Builder clearUserInfo()Optional. User information.
.google.cloud.retail.v2alpha.UserInfo user_info = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
clearVisitorId()
public ConversationalSearchRequest.Builder clearVisitorId()Required. 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 should be the same identifier as UserEvent.visitor_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 visitor_id = 9 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
This builder for chaining. |
clone()
public ConversationalSearchRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
getBranch()
public String getBranch() Required. The branch resource name, such as
projects/*/locations/global/catalogs/default_catalog/branches/0.
Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.
string branch = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The branch. |
getBranchBytes()
public ByteString getBranchBytes() Required. The branch resource name, such as
projects/*/locations/global/catalogs/default_catalog/branches/0.
Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.
string branch = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for branch. |
getConversationId()
public String getConversationId()Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id. For the initial request, this should be empty.
string conversation_id = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The conversationId. |
getConversationIdBytes()
public ByteString getConversationIdBytes()Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id. For the initial request, this should be empty.
string conversation_id = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for conversationId. |
getConversationalFilteringSpec()
public ConversationalSearchRequest.ConversationalFilteringSpec getConversationalFilteringSpec()Optional. This field specifies all conversational filtering related parameters.
.google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec conversational_filtering_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.ConversationalFilteringSpec |
The conversationalFilteringSpec. |
getConversationalFilteringSpecBuilder()
public ConversationalSearchRequest.ConversationalFilteringSpec.Builder getConversationalFilteringSpecBuilder()Optional. This field specifies all conversational filtering related parameters.
.google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec conversational_filtering_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.ConversationalFilteringSpec.Builder |
|
getConversationalFilteringSpecOrBuilder()
public ConversationalSearchRequest.ConversationalFilteringSpecOrBuilder getConversationalFilteringSpecOrBuilder()Optional. This field specifies all conversational filtering related parameters.
.google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec conversational_filtering_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.ConversationalFilteringSpecOrBuilder |
|
getDefaultInstanceForType()
public ConversationalSearchRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getPageCategories(int index)
public String getPageCategories(int index)Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories;
To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).
Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The pageCategories at the given index. |
getPageCategoriesBytes(int index)
public ByteString getPageCategoriesBytes(int index)Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories;
To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).
Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the pageCategories at the given index. |
getPageCategoriesCount()
public int getPageCategoriesCount()Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories;
To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).
Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The count of pageCategories. |
getPageCategoriesList()
public ProtocolStringList getPageCategoriesList()Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories;
To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).
Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the pageCategories. |
getPlacement()
public String getPlacement() Required. The resource name of the search engine placement, such as
projects/*/locations/global/catalogs/default_catalog/placements/default_search
or
projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config
This field is used to identify the serving config name and the set
of models that will be used to make the search.
string placement = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The placement. |
getPlacementBytes()
public ByteString getPlacementBytes() Required. The resource name of the search engine placement, such as
projects/*/locations/global/catalogs/default_catalog/placements/default_search
or
projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config
This field is used to identify the serving config name and the set
of models that will be used to make the search.
string placement = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for placement. |
getQuery()
public String getQuery()Optional. Raw search query to be searched for.
If this field is empty, the request is considered a category browsing request.
string query = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The query. |
getQueryBytes()
public ByteString getQueryBytes()Optional. Raw search query to be searched for.
If this field is empty, the request is considered a category browsing request.
string query = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for query. |
getSearchParams()
public ConversationalSearchRequest.SearchParams getSearchParams()Optional. Search parameters.
.google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams search_params = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.SearchParams |
The searchParams. |
getSearchParamsBuilder()
public ConversationalSearchRequest.SearchParams.Builder getSearchParamsBuilder()Optional. Search parameters.
.google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams search_params = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.SearchParams.Builder |
|
getSearchParamsOrBuilder()
public ConversationalSearchRequest.SearchParamsOrBuilder getSearchParamsOrBuilder()Optional. Search parameters.
.google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams search_params = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.SearchParamsOrBuilder |
|
getUserInfo()
public UserInfo getUserInfo()Optional. User information.
.google.cloud.retail.v2alpha.UserInfo user_info = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
UserInfo |
The userInfo. |
getUserInfoBuilder()
public UserInfo.Builder getUserInfoBuilder()Optional. User information.
.google.cloud.retail.v2alpha.UserInfo user_info = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder |
|
getUserInfoOrBuilder()
public UserInfoOrBuilder getUserInfoOrBuilder()Optional. User information.
.google.cloud.retail.v2alpha.UserInfo user_info = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
UserInfoOrBuilder |
|
getVisitorId()
public String getVisitorId()Required. 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 should be the same identifier as UserEvent.visitor_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 visitor_id = 9 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The visitorId. |
getVisitorIdBytes()
public ByteString getVisitorIdBytes()Required. 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 should be the same identifier as UserEvent.visitor_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 visitor_id = 9 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for visitorId. |
hasConversationalFilteringSpec()
public boolean hasConversationalFilteringSpec()Optional. This field specifies all conversational filtering related parameters.
.google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec conversational_filtering_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the conversationalFilteringSpec field is set. |
hasSearchParams()
public boolean hasSearchParams()Optional. Search parameters.
.google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams search_params = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the searchParams field is set. |
hasUserInfo()
public boolean hasUserInfo()Optional. User information.
.google.cloud.retail.v2alpha.UserInfo user_info = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the userInfo field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeConversationalFilteringSpec(ConversationalSearchRequest.ConversationalFilteringSpec value)
public ConversationalSearchRequest.Builder mergeConversationalFilteringSpec(ConversationalSearchRequest.ConversationalFilteringSpec value)Optional. This field specifies all conversational filtering related parameters.
.google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec conversational_filtering_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ConversationalSearchRequest.ConversationalFilteringSpec |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
mergeFrom(ConversationalSearchRequest other)
public ConversationalSearchRequest.Builder mergeFrom(ConversationalSearchRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ConversationalSearchRequest |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ConversationalSearchRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ConversationalSearchRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
mergeSearchParams(ConversationalSearchRequest.SearchParams value)
public ConversationalSearchRequest.Builder mergeSearchParams(ConversationalSearchRequest.SearchParams value)Optional. Search parameters.
.google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams search_params = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ConversationalSearchRequest.SearchParams |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ConversationalSearchRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
mergeUserInfo(UserInfo value)
public ConversationalSearchRequest.Builder mergeUserInfo(UserInfo value)Optional. User information.
.google.cloud.retail.v2alpha.UserInfo user_info = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
UserInfo |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
setBranch(String value)
public ConversationalSearchRequest.Builder setBranch(String value) Required. The branch resource name, such as
projects/*/locations/global/catalogs/default_catalog/branches/0.
Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.
string branch = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe branch to set. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
This builder for chaining. |
setBranchBytes(ByteString value)
public ConversationalSearchRequest.Builder setBranchBytes(ByteString value) Required. The branch resource name, such as
projects/*/locations/global/catalogs/default_catalog/branches/0.
Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.
string branch = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for branch to set. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
This builder for chaining. |
setConversationId(String value)
public ConversationalSearchRequest.Builder setConversationId(String value)Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id. For the initial request, this should be empty.
string conversation_id = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe conversationId to set. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
This builder for chaining. |
setConversationIdBytes(ByteString value)
public ConversationalSearchRequest.Builder setConversationIdBytes(ByteString value)Optional. This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResponse.conversation_id. For the initial request, this should be empty.
string conversation_id = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for conversationId to set. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
This builder for chaining. |
setConversationalFilteringSpec(ConversationalSearchRequest.ConversationalFilteringSpec value)
public ConversationalSearchRequest.Builder setConversationalFilteringSpec(ConversationalSearchRequest.ConversationalFilteringSpec value)Optional. This field specifies all conversational filtering related parameters.
.google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec conversational_filtering_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ConversationalSearchRequest.ConversationalFilteringSpec |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
setConversationalFilteringSpec(ConversationalSearchRequest.ConversationalFilteringSpec.Builder builderForValue)
public ConversationalSearchRequest.Builder setConversationalFilteringSpec(ConversationalSearchRequest.ConversationalFilteringSpec.Builder builderForValue)Optional. This field specifies all conversational filtering related parameters.
.google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec conversational_filtering_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ConversationalSearchRequest.ConversationalFilteringSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ConversationalSearchRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
setPageCategories(int index, String value)
public ConversationalSearchRequest.Builder setPageCategories(int index, String value)Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories;
To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).
Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].
repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe pageCategories to set. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
This builder for chaining. |
setPlacement(String value)
public ConversationalSearchRequest.Builder setPlacement(String value) Required. The resource name of the search engine placement, such as
projects/*/locations/global/catalogs/default_catalog/placements/default_search
or
projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config
This field is used to identify the serving config name and the set
of models that will be used to make the search.
string placement = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe placement to set. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
This builder for chaining. |
setPlacementBytes(ByteString value)
public ConversationalSearchRequest.Builder setPlacementBytes(ByteString value) Required. The resource name of the search engine placement, such as
projects/*/locations/global/catalogs/default_catalog/placements/default_search
or
projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config
This field is used to identify the serving config name and the set
of models that will be used to make the search.
string placement = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for placement to set. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
This builder for chaining. |
setQuery(String value)
public ConversationalSearchRequest.Builder setQuery(String value)Optional. Raw search query to be searched for.
If this field is empty, the request is considered a category browsing request.
string query = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe query to set. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
This builder for chaining. |
setQueryBytes(ByteString value)
public ConversationalSearchRequest.Builder setQueryBytes(ByteString value)Optional. Raw search query to be searched for.
If this field is empty, the request is considered a category browsing request.
string query = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for query to set. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ConversationalSearchRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
setSearchParams(ConversationalSearchRequest.SearchParams value)
public ConversationalSearchRequest.Builder setSearchParams(ConversationalSearchRequest.SearchParams value)Optional. Search parameters.
.google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams search_params = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ConversationalSearchRequest.SearchParams |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
setSearchParams(ConversationalSearchRequest.SearchParams.Builder builderForValue)
public ConversationalSearchRequest.Builder setSearchParams(ConversationalSearchRequest.SearchParams.Builder builderForValue)Optional. Search parameters.
.google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams search_params = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ConversationalSearchRequest.SearchParams.Builder |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ConversationalSearchRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
setUserInfo(UserInfo value)
public ConversationalSearchRequest.Builder setUserInfo(UserInfo value)Optional. User information.
.google.cloud.retail.v2alpha.UserInfo user_info = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
UserInfo |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
setUserInfo(UserInfo.Builder builderForValue)
public ConversationalSearchRequest.Builder setUserInfo(UserInfo.Builder builderForValue)Optional. User information.
.google.cloud.retail.v2alpha.UserInfo user_info = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
UserInfo.Builder |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
|
setVisitorId(String value)
public ConversationalSearchRequest.Builder setVisitorId(String value)Required. 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 should be the same identifier as UserEvent.visitor_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 visitor_id = 9 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe visitorId to set. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
This builder for chaining. |
setVisitorIdBytes(ByteString value)
public ConversationalSearchRequest.Builder setVisitorIdBytes(ByteString value)Required. 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 should be the same identifier as UserEvent.visitor_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 visitor_id = 9 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for visitorId to set. |
| Returns | |
|---|---|
| Type | Description |
ConversationalSearchRequest.Builder |
This builder for chaining. |