- 0.49.0 (latest)
- 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 interface SearchRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsParams(String key)
public abstract boolean containsParams(String key)Additional search parameters.
For public website search only, supported values are:
user_country_code: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided.search_type: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching.
map<string, .google.protobuf.Value> params = 11;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
containsUserLabels(String key)
public abstract boolean containsUserLabels(String key)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 = 22;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getBoostSpec()
public abstract SearchRequest.BoostSpec getBoostSpec()Boost specification to boost certain documents.
.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpec | The boostSpec. |
getBoostSpecOrBuilder()
public abstract SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()Boost specification to boost certain documents.
.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.BoostSpecOrBuilder | |
getBranch()
public abstract String getBranch() The branch resource name, such as
projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0.
Use default_branch as the branch ID or leave this field empty, to search
documents under the default branch.
string branch = 2 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The branch. |
getBranchBytes()
public abstract ByteString getBranchBytes() The branch resource name, such as
projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0.
Use default_branch as the branch ID or leave this field empty, to search
documents under the default branch.
string branch = 2 [(.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for branch. |
getContentSearchSpec()
public abstract SearchRequest.ContentSearchSpec getContentSearchSpec()The content search spec that configs the desired behavior of content search.
.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.ContentSearchSpec | The contentSearchSpec. |
getContentSearchSpecOrBuilder()
public abstract SearchRequest.ContentSearchSpecOrBuilder getContentSearchSpecOrBuilder()The content search spec that configs the desired behavior of content search.
.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.ContentSearchSpecOrBuilder | |
getFacetSpecs(int index)
public abstract SearchRequest.FacetSpec getFacetSpecs(int index)Facet specifications for faceted search. If empty, no facets are returned.
A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT
error is returned.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpec | |
getFacetSpecsCount()
public abstract int getFacetSpecsCount()Facet specifications for faceted search. If empty, no facets are returned.
A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT
error is returned.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;
| Returns | |
|---|---|
| Type | Description |
int | |
getFacetSpecsList()
public abstract List<SearchRequest.FacetSpec> getFacetSpecsList()Facet specifications for faceted search. If empty, no facets are returned.
A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT
error is returned.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;
| Returns | |
|---|---|
| Type | Description |
List<FacetSpec> | |
getFacetSpecsOrBuilder(int index)
public abstract SearchRequest.FacetSpecOrBuilder getFacetSpecsOrBuilder(int index)Facet specifications for faceted search. If empty, no facets are returned.
A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT
error is returned.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.FacetSpecOrBuilder | |
getFacetSpecsOrBuilderList()
public abstract List<? extends SearchRequest.FacetSpecOrBuilder> getFacetSpecsOrBuilderList()Facet specifications for faceted search. If empty, no facets are returned.
A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT
error is returned.
repeated .google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpec facet_specs = 9;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.discoveryengine.v1beta.SearchRequest.FacetSpecOrBuilder> | |
getFilter()
public abstract String getFilter()The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive.
If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string filter = 7;
| Returns | |
|---|---|
| Type | Description |
String | The filter. |
getFilterBytes()
public abstract ByteString getFilterBytes()The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive.
If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string filter = 7;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for filter. |
getOffset()
public abstract int getOffset()A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset.
If this field is negative, an INVALID_ARGUMENT is returned.
int32 offset = 6;
| Returns | |
|---|---|
| Type | Description |
int | The offset. |
getOrderBy()
public abstract String getOrderBy()The order in which documents are returned. Document can be ordered by a field in an Document object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive.
If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string order_by = 8;
| Returns | |
|---|---|
| Type | Description |
String | The orderBy. |
getOrderByBytes()
public abstract ByteString getOrderByBytes()The order in which documents are returned. Document can be ordered by a field in an Document object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive.
If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string order_by = 8;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for orderBy. |
getPageSize()
public abstract int getPageSize()Maximum number of Documents to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 100. Values above 100 will be coerced to 100.
If this field is negative, an INVALID_ARGUMENT is returned.
int32 page_size = 4;
| Returns | |
|---|---|
| Type | Description |
int | The pageSize. |
getPageToken()
public abstract String getPageToken()A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
SearchService.Search
must match the call that provided the page token. Otherwise, an
INVALID_ARGUMENT error is returned.
string page_token = 5;
| Returns | |
|---|---|
| Type | Description |
String | The pageToken. |
getPageTokenBytes()
public abstract ByteString getPageTokenBytes()A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
SearchService.Search
must match the call that provided the page token. Otherwise, an
INVALID_ARGUMENT error is returned.
string page_token = 5;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for pageToken. |
getParams()
public abstract Map<String,Value> getParams()Use #getParamsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Value> | |
getParamsCount()
public abstract int getParamsCount()Additional search parameters.
For public website search only, supported values are:
user_country_code: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided.search_type: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching.
map<string, .google.protobuf.Value> params = 11;
| Returns | |
|---|---|
| Type | Description |
int | |
getParamsMap()
public abstract Map<String,Value> getParamsMap()Additional search parameters.
For public website search only, supported values are:
user_country_code: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided.search_type: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching.
map<string, .google.protobuf.Value> params = 11;
| Returns | |
|---|---|
| Type | Description |
Map<String,Value> | |
getParamsOrDefault(String key, Value defaultValue)
public abstract Value getParamsOrDefault(String key, Value defaultValue)Additional search parameters.
For public website search only, supported values are:
user_country_code: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided.search_type: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching.
map<string, .google.protobuf.Value> params = 11;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | Value |
| Returns | |
|---|---|
| Type | Description |
Value | |
getParamsOrThrow(String key)
public abstract Value getParamsOrThrow(String key)Additional search parameters.
For public website search only, supported values are:
user_country_code: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided.search_type: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching.
map<string, .google.protobuf.Value> params = 11;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
Value | |
getQuery()
public abstract String getQuery()Raw search query.
string query = 3;
| Returns | |
|---|---|
| Type | Description |
String | The query. |
getQueryBytes()
public abstract ByteString getQueryBytes()Raw search query.
string query = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for query. |
getQueryExpansionSpec()
public abstract SearchRequest.QueryExpansionSpec getQueryExpansionSpec()The query expansion specification that specifies the conditions under which query expansion will occur.
.google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.QueryExpansionSpec | The queryExpansionSpec. |
getQueryExpansionSpecOrBuilder()
public abstract SearchRequest.QueryExpansionSpecOrBuilder getQueryExpansionSpecOrBuilder()The query expansion specification that specifies the conditions under which query expansion will occur.
.google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.QueryExpansionSpecOrBuilder | |
getSafeSearch()
public abstract boolean getSafeSearch()Whether to turn on safe search. This is only supported for [ContentConfig.PUBLIC_WEBSITE][].
bool safe_search = 20;
| Returns | |
|---|---|
| Type | Description |
boolean | The safeSearch. |
getServingConfig()
public abstract String getServingConfig() Required. The resource name of the Search serving config, such as
projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config.
This field is used to identify the serving configuration name, set
of models used to make the search.
string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The servingConfig. |
getServingConfigBytes()
public abstract ByteString getServingConfigBytes() Required. The resource name of the Search serving config, such as
projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config.
This field is used to identify the serving configuration name, set
of models used to make the search.
string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for servingConfig. |
getSpellCorrectionSpec()
public abstract SearchRequest.SpellCorrectionSpec getSpellCorrectionSpec()The spell correction specification that specifies the mode under which spell correction will take effect.
.google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.SpellCorrectionSpec | The spellCorrectionSpec. |
getSpellCorrectionSpecOrBuilder()
public abstract SearchRequest.SpellCorrectionSpecOrBuilder getSpellCorrectionSpecOrBuilder()The spell correction specification that specifies the mode under which spell correction will take effect.
.google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
| Returns | |
|---|---|
| Type | Description |
SearchRequest.SpellCorrectionSpecOrBuilder | |
getUserInfo()
public abstract UserInfo getUserInfo()Information about the end user. Highly recommended for analytics. The user_agent string in UserInfo will be used to deduce device_type for analytics.
.google.cloud.discoveryengine.v1beta.UserInfo user_info = 21;
| Returns | |
|---|---|
| Type | Description |
UserInfo | The userInfo. |
getUserInfoOrBuilder()
public abstract UserInfoOrBuilder getUserInfoOrBuilder()Information about the end user. Highly recommended for analytics. The user_agent string in UserInfo will be used to deduce device_type for analytics.
.google.cloud.discoveryengine.v1beta.UserInfo user_info = 21;
| Returns | |
|---|---|
| Type | Description |
UserInfoOrBuilder | |
getUserLabels()
public abstract Map<String,String> getUserLabels()Use #getUserLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getUserLabelsCount()
public abstract int getUserLabelsCount()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 = 22;
| Returns | |
|---|---|
| Type | Description |
int | |
getUserLabelsMap()
public abstract Map<String,String> getUserLabelsMap()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 = 22;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getUserLabelsOrDefault(String key, String defaultValue)
public abstract String getUserLabelsOrDefault(String key, String defaultValue)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 = 22;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getUserLabelsOrThrow(String key)
public abstract String getUserLabelsOrThrow(String key)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 = 22;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getUserPseudoId()
public abstract 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 CompleteQueryRequest.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 = 15;
| Returns | |
|---|---|
| Type | Description |
String | The userPseudoId. |
getUserPseudoIdBytes()
public abstract 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 CompleteQueryRequest.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 = 15;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for userPseudoId. |
hasBoostSpec()
public abstract boolean hasBoostSpec()Boost specification to boost certain documents.
.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the boostSpec field is set. |
hasContentSearchSpec()
public abstract boolean hasContentSearchSpec()The content search spec that configs the desired behavior of content search.
.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec content_search_spec = 24;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the contentSearchSpec field is set. |
hasQueryExpansionSpec()
public abstract boolean hasQueryExpansionSpec()The query expansion specification that specifies the conditions under which query expansion will occur.
.google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the queryExpansionSpec field is set. |
hasSpellCorrectionSpec()
public abstract boolean hasSpellCorrectionSpec()The spell correction specification that specifies the mode under which spell correction will take effect.
.google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the spellCorrectionSpec field is set. |
hasUserInfo()
public abstract boolean hasUserInfo()Information about the end user. Highly recommended for analytics. The user_agent string in UserInfo will be used to deduce device_type for analytics.
.google.cloud.discoveryengine.v1beta.UserInfo user_info = 21;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the userInfo field is set. |