- 2.72.0 (latest)
- 2.70.0
- 2.69.0
- 2.66.0
- 2.65.0
- 2.64.0
- 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 interface ConversationalSearchRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsUserLabels(String key)
public abstract boolean containsUserLabels(String key)Optional. The user labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
- Each label must be a key-value pair.
- Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
- Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
- The key portion of a label must be unique. However, you can use the same key with multiple resources.
Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
map<string, string> user_labels = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getBranch()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |
getConversationalFilteringSpecOrBuilder()
public abstract 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 |
|
getPageCategories(int index)
public abstract 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 abstract 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 abstract 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 abstract List<String> 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 |
List<String> |
A list containing the pageCategories. |
getPlacement()
public abstract 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 abstract 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 abstract 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 abstract 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. |
getSafetySettings(int index)
public abstract SafetySetting getSafetySettings(int index)Optional. The safety settings to be applied to the generated content.
repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SafetySetting |
|
getSafetySettingsCount()
public abstract int getSafetySettingsCount()Optional. The safety settings to be applied to the generated content.
repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getSafetySettingsList()
public abstract List<SafetySetting> getSafetySettingsList()Optional. The safety settings to be applied to the generated content.
repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<SafetySetting> |
|
getSafetySettingsOrBuilder(int index)
public abstract SafetySettingOrBuilder getSafetySettingsOrBuilder(int index)Optional. The safety settings to be applied to the generated content.
repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SafetySettingOrBuilder |
|
getSafetySettingsOrBuilderList()
public abstract List<? extends SafetySettingOrBuilder> getSafetySettingsOrBuilderList()Optional. The safety settings to be applied to the generated content.
repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.retail.v2alpha.SafetySettingOrBuilder> |
|
getSearchParams()
public abstract 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. |
getSearchParamsOrBuilder()
public abstract 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 abstract UserInfo getUserInfo()Optional. User information.
.google.cloud.retail.v2alpha.UserInfo user_info = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
UserInfo |
The userInfo. |
getUserInfoOrBuilder()
public abstract UserInfoOrBuilder getUserInfoOrBuilder()Optional. User information.
.google.cloud.retail.v2alpha.UserInfo user_info = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
UserInfoOrBuilder |
|
getUserLabels() (deprecated)
public abstract Map<String,String> getUserLabels()Use #getUserLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getUserLabelsCount()
public abstract int getUserLabelsCount()Optional. The user labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
- Each label must be a key-value pair.
- Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
- Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
- The key portion of a label must be unique. However, you can use the same key with multiple resources.
Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
map<string, string> user_labels = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getUserLabelsMap()
public abstract Map<String,String> getUserLabelsMap()Optional. The user labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
- Each label must be a key-value pair.
- Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
- Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
- The key portion of a label must be unique. However, you can use the same key with multiple resources.
Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
map<string, string> user_labels = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getUserLabelsOrDefault(String key, String defaultValue)
public abstract String getUserLabelsOrDefault(String key, String defaultValue)Optional. The user labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
- Each label must be a key-value pair.
- Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
- Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
- The key portion of a label must be unique. However, you can use the same key with multiple resources.
Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
map<string, string> user_labels = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getUserLabelsOrThrow(String key)
public abstract String getUserLabelsOrThrow(String key)Optional. The user labels applied to a resource must meet the following requirements:
- Each resource can have multiple labels, up to a maximum of 64.
- Each label must be a key-value pair.
- Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
- Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
- The key portion of a label must be unique. However, you can use the same key with multiple resources.
Keys must start with a lowercase letter or international character.
See Google Cloud Document for more details.
map<string, string> user_labels = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getVisitorId()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |