- 2.49.0 (latest)
- 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 final class SearchRequest extends GeneratedMessageV3 implements SearchRequestOrBuilder
Request message for SearchService.Search method.
Protobuf type google.cloud.retail.v2beta.SearchRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchRequestImplements
SearchRequestOrBuilderStatic Fields
BOOST_SPEC_FIELD_NUMBER
public static final int BOOST_SPEC_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
BRANCH_FIELD_NUMBER
public static final int BRANCH_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
CANONICAL_FILTER_FIELD_NUMBER
public static final int CANONICAL_FILTER_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
DYNAMIC_FACET_SPEC_FIELD_NUMBER
public static final int DYNAMIC_FACET_SPEC_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
ENTITY_FIELD_NUMBER
public static final int ENTITY_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
FACET_SPECS_FIELD_NUMBER
public static final int FACET_SPECS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
OFFSET_FIELD_NUMBER
public static final int OFFSET_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
PAGE_CATEGORIES_FIELD_NUMBER
public static final int PAGE_CATEGORIES_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
PERSONALIZATION_SPEC_FIELD_NUMBER
public static final int PERSONALIZATION_SPEC_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
PLACEMENT_FIELD_NUMBER
public static final int PLACEMENT_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
QUERY_EXPANSION_SPEC_FIELD_NUMBER
public static final int QUERY_EXPANSION_SPEC_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SEARCH_MODE_FIELD_NUMBER
public static final int SEARCH_MODE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SPELL_CORRECTION_SPEC_FIELD_NUMBER
public static final int SPELL_CORRECTION_SPEC_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
USER_INFO_FIELD_NUMBER
public static final int USER_INFO_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
VARIANT_ROLLUP_KEYS_FIELD_NUMBER
public static final int VARIANT_ROLLUP_KEYS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
VISITOR_ID_FIELD_NUMBER
public static final int VISITOR_ID_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static SearchRequest getDefaultInstance()
Returns | |
---|---|
Type | Description |
SearchRequest |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static SearchRequest.Builder newBuilder()
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
newBuilder(SearchRequest prototype)
public static SearchRequest.Builder newBuilder(SearchRequest prototype)
Parameter | |
---|---|
Name | Description |
prototype | SearchRequest |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
parseDelimitedFrom(InputStream input)
public static SearchRequest parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
SearchRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static SearchRequest parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data | byte[] |
Returns | |
---|---|
Type | Description |
SearchRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static SearchRequest parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data | ByteString |
Returns | |
---|---|
Type | Description |
SearchRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static SearchRequest parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input | CodedInputStream |
Returns | |
---|---|
Type | Description |
SearchRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static SearchRequest parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
SearchRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchRequest |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static SearchRequest parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data | ByteBuffer |
Returns | |
---|---|
Type | Description |
SearchRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchRequest |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<SearchRequest> parser()
Returns | |
---|---|
Type | Description |
Parser<SearchRequest> |
Methods
containsLabels(String key)
public boolean containsLabels(String key)
The 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> labels = 34;
Parameter | |
---|---|
Name | Description |
key | String |
Returns | |
---|---|
Type | Description |
boolean |
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj | Object |
Returns | |
---|---|
Type | Description |
boolean |
getBoostSpec()
public SearchRequest.BoostSpec getBoostSpec()
Boost specification to boost certain products. See more details at this user guide.
Notice that if both ServingConfig.boost_control_ids and SearchRequest.boost_spec are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the final boost score is equal to the sum of the boost scores from all matched boost conditions.
.google.cloud.retail.v2beta.SearchRequest.BoostSpec boost_spec = 13;
Returns | |
---|---|
Type | Description |
SearchRequest.BoostSpec | The boostSpec. |
getBoostSpecOrBuilder()
public SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()
Boost specification to boost certain products. See more details at this user guide.
Notice that if both ServingConfig.boost_control_ids and SearchRequest.boost_spec are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the final boost score is equal to the sum of the boost scores from all matched boost conditions.
.google.cloud.retail.v2beta.SearchRequest.BoostSpec boost_spec = 13;
Returns | |
---|---|
Type | Description |
SearchRequest.BoostSpecOrBuilder |
getBranch()
public String getBranch()
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.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
String | The branch. |
getBranchBytes()
public ByteString getBranchBytes()
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.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString | The bytes for branch. |
getCanonicalFilter()
public String getCanonicalFilter()
The default filter that is applied when a user performs a search without checking any filters on the search page.
The filter applied to every search request when quality improvement such as query expansion is needed. For example, if a query does not have enough results, an expanded query with SearchRequest.canonical_filter will be returned as a supplement of the original query. This field is strongly recommended to achieve high search quality.
See SearchRequest.filter for more details about filter syntax.
string canonical_filter = 28;
Returns | |
---|---|
Type | Description |
String | The canonicalFilter. |
getCanonicalFilterBytes()
public ByteString getCanonicalFilterBytes()
The default filter that is applied when a user performs a search without checking any filters on the search page.
The filter applied to every search request when quality improvement such as query expansion is needed. For example, if a query does not have enough results, an expanded query with SearchRequest.canonical_filter will be returned as a supplement of the original query. This field is strongly recommended to achieve high search quality.
See SearchRequest.filter for more details about filter syntax.
string canonical_filter = 28;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for canonicalFilter. |
getDefaultInstanceForType()
public SearchRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
SearchRequest |
getDynamicFacetSpec() (deprecated)
public SearchRequest.DynamicFacetSpec getDynamicFacetSpec()
Deprecated. google.cloud.retail.v2beta.SearchRequest.dynamic_facet_spec is deprecated. See google/cloud/retail/v2beta/search_service.proto;l=599
Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets. Do not set this field.
The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated.
.google.cloud.retail.v2beta.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];
Returns | |
---|---|
Type | Description |
SearchRequest.DynamicFacetSpec | The dynamicFacetSpec. |
getDynamicFacetSpecOrBuilder()
public SearchRequest.DynamicFacetSpecOrBuilder getDynamicFacetSpecOrBuilder()
Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets. Do not set this field.
The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated.
.google.cloud.retail.v2beta.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];
Returns | |
---|---|
Type | Description |
SearchRequest.DynamicFacetSpecOrBuilder |
getEntity()
public String getEntity()
The entity for customers that may run multiple different entities, domains,
sites or regions, for example, Google US
, Google Ads
, Waymo
,
google.com
, youtube.com
, etc.
If this is set, it should be exactly matched with
UserEvent.entity to get
search results boosted by entity.
string entity = 38;
Returns | |
---|---|
Type | Description |
String | The entity. |
getEntityBytes()
public ByteString getEntityBytes()
The entity for customers that may run multiple different entities, domains,
sites or regions, for example, Google US
, Google Ads
, Waymo
,
google.com
, youtube.com
, etc.
If this is set, it should be exactly matched with
UserEvent.entity to get
search results boosted by entity.
string entity = 38;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for entity. |
getFacetSpecs(int index)
public SearchRequest.FacetSpec getFacetSpecs(int index)
Facet specifications for faceted search. If empty, no facets are returned.
A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
SearchRequest.FacetSpec |
getFacetSpecsCount()
public int getFacetSpecsCount()
Facet specifications for faceted search. If empty, no facets are returned.
A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Returns | |
---|---|
Type | Description |
int |
getFacetSpecsList()
public List<SearchRequest.FacetSpec> getFacetSpecsList()
Facet specifications for faceted search. If empty, no facets are returned.
A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Returns | |
---|---|
Type | Description |
List<FacetSpec> |
getFacetSpecsOrBuilder(int index)
public SearchRequest.FacetSpecOrBuilder getFacetSpecsOrBuilder(int index)
Facet specifications for faceted search. If empty, no facets are returned.
A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Parameter | |
---|---|
Name | Description |
index | int |
Returns | |
---|---|
Type | Description |
SearchRequest.FacetSpecOrBuilder |
getFacetSpecsOrBuilderList()
public List<? extends SearchRequest.FacetSpecOrBuilder> getFacetSpecsOrBuilderList()
Facet specifications for faceted search. If empty, no facets are returned.
A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.
repeated .google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_specs = 12;
Returns | |
---|---|
Type | Description |
List<? extends com.google.cloud.retail.v2beta.SearchRequest.FacetSpecOrBuilder> |
getFilter()
public String getFilter()
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. Filter expression is case-sensitive. See more details at this user guide.
If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string filter = 10;
Returns | |
---|---|
Type | Description |
String | The filter. |
getFilterBytes()
public ByteString getFilterBytes()
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. Filter expression is case-sensitive. See more details at this user guide.
If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string filter = 10;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for filter. |
getLabels()
public Map<String,String> getLabels()
Use #getLabelsMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getLabelsCount()
public int getLabelsCount()
The 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> labels = 34;
Returns | |
---|---|
Type | Description |
int |
getLabelsMap()
public Map<String,String> getLabelsMap()
The 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> labels = 34;
Returns | |
---|---|
Type | Description |
Map<String,String> |
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
The 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> labels = 34;
Parameters | |
---|---|
Name | Description |
key | String |
defaultValue | String |
Returns | |
---|---|
Type | Description |
String |
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
The 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> labels = 34;
Parameter | |
---|---|
Name | Description |
key | String |
Returns | |
---|---|
Type | Description |
String |
getOffset()
public int getOffset()
A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Products 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 = 9;
Returns | |
---|---|
Type | Description |
int | The offset. |
getOrderBy()
public String getOrderBy()
The order in which products are returned. Products can be ordered by a field in an Product object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive. See more details at this user guide.
If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string order_by = 11;
Returns | |
---|---|
Type | Description |
String | The orderBy. |
getOrderByBytes()
public ByteString getOrderByBytes()
The order in which products are returned. Products can be ordered by a field in an Product object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive. See more details at this user guide.
If this field is unrecognizable, an INVALID_ARGUMENT is returned.
string order_by = 11;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for orderBy. |
getPageCategories(int index)
public String getPageCategories(int index)
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 = 23;
Parameter | |
---|---|
Name | Description |
index | int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String | The pageCategories at the given index. |
getPageCategoriesBytes(int index)
public ByteString getPageCategoriesBytes(int index)
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 = 23;
Parameter | |
---|---|
Name | Description |
index | int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString | The bytes of the pageCategories at the given index. |
getPageCategoriesCount()
public int getPageCategoriesCount()
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 = 23;
Returns | |
---|---|
Type | Description |
int | The count of pageCategories. |
getPageCategoriesList()
public ProtocolStringList getPageCategoriesList()
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 = 23;
Returns | |
---|---|
Type | Description |
ProtocolStringList | A list containing the pageCategories. |
getPageSize()
public int getPageSize()
Maximum number of Products to return. If unspecified, defaults to a reasonable value. The maximum allowed value is 120. Values above 120 will be coerced to 120.
If this field is negative, an INVALID_ARGUMENT is returned.
int32 page_size = 7;
Returns | |
---|---|
Type | Description |
int | The pageSize. |
getPageToken()
public String getPageToken()
A page token SearchResponse.next_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 = 8;
Returns | |
---|---|
Type | Description |
String | The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()
A page token SearchResponse.next_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 = 8;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for pageToken. |
getParserForType()
public Parser<SearchRequest> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<SearchRequest> |
getPersonalizationSpec()
public SearchRequest.PersonalizationSpec getPersonalizationSpec()
The specification for personalization.
Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set. SearchRequest.personalization_spec will override ServingConfig.personalization_spec.
.google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec personalization_spec = 32;
Returns | |
---|---|
Type | Description |
SearchRequest.PersonalizationSpec | The personalizationSpec. |
getPersonalizationSpecOrBuilder()
public SearchRequest.PersonalizationSpecOrBuilder getPersonalizationSpecOrBuilder()
The specification for personalization.
Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set. SearchRequest.personalization_spec will override ServingConfig.personalization_spec.
.google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec personalization_spec = 32;
Returns | |
---|---|
Type | Description |
SearchRequest.PersonalizationSpecOrBuilder |
getPlacement()
public String getPlacement()
Required. The resource name of the Retail Search serving config, such as
projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config
or the name of the legacy placement resource, such as
projects/*/locations/global/catalogs/default_catalog/placements/default_search
.
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 Retail Search serving config, such as
projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config
or the name of the legacy placement resource, such as
projects/*/locations/global/catalogs/default_catalog/placements/default_search
.
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()
Raw search query.
If this field is empty, the request is considered a category browsing request and returned results are based on filter and page_categories.
string query = 3;
Returns | |
---|---|
Type | Description |
String | The query. |
getQueryBytes()
public ByteString getQueryBytes()
Raw search query.
If this field is empty, the request is considered a category browsing request and returned results are based on filter and page_categories.
string query = 3;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for query. |
getQueryExpansionSpec()
public SearchRequest.QueryExpansionSpec getQueryExpansionSpec()
The query expansion specification that specifies the conditions under which query expansion will occur. See more details at this user guide.
.google.cloud.retail.v2beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 14;
Returns | |
---|---|
Type | Description |
SearchRequest.QueryExpansionSpec | The queryExpansionSpec. |
getQueryExpansionSpecOrBuilder()
public SearchRequest.QueryExpansionSpecOrBuilder getQueryExpansionSpecOrBuilder()
The query expansion specification that specifies the conditions under which query expansion will occur. See more details at this user guide.
.google.cloud.retail.v2beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 14;
Returns | |
---|---|
Type | Description |
SearchRequest.QueryExpansionSpecOrBuilder |
getSearchMode()
public SearchRequest.SearchMode getSearchMode()
The search mode of the search request. If not specified, a single search request triggers both product search and faceted search.
.google.cloud.retail.v2beta.SearchRequest.SearchMode search_mode = 31;
Returns | |
---|---|
Type | Description |
SearchRequest.SearchMode | The searchMode. |
getSearchModeValue()
public int getSearchModeValue()
The search mode of the search request. If not specified, a single search request triggers both product search and faceted search.
.google.cloud.retail.v2beta.SearchRequest.SearchMode search_mode = 31;
Returns | |
---|---|
Type | Description |
int | The enum numeric value on the wire for searchMode. |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getSpellCorrectionSpec()
public SearchRequest.SpellCorrectionSpec getSpellCorrectionSpec()
The spell correction specification that specifies the mode under which spell correction will take effect.
optional .google.cloud.retail.v2beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 35;
Returns | |
---|---|
Type | Description |
SearchRequest.SpellCorrectionSpec | The spellCorrectionSpec. |
getSpellCorrectionSpecOrBuilder()
public SearchRequest.SpellCorrectionSpecOrBuilder getSpellCorrectionSpecOrBuilder()
The spell correction specification that specifies the mode under which spell correction will take effect.
optional .google.cloud.retail.v2beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 35;
Returns | |
---|---|
Type | Description |
SearchRequest.SpellCorrectionSpecOrBuilder |
getUserInfo()
public UserInfo getUserInfo()
User information.
.google.cloud.retail.v2beta.UserInfo user_info = 5;
Returns | |
---|---|
Type | Description |
UserInfo | The userInfo. |
getUserInfoOrBuilder()
public UserInfoOrBuilder getUserInfoOrBuilder()
User information.
.google.cloud.retail.v2beta.UserInfo user_info = 5;
Returns | |
---|---|
Type | Description |
UserInfoOrBuilder |
getVariantRollupKeys(int index)
public String getVariantRollupKeys(int index)
The keys to fetch and rollup the matching variant Products attributes, FulfillmentInfo or LocalInventorys attributes. The attributes from all the matching variant Products or LocalInventorys are merged and de-duplicated. Notice that rollup attributes will lead to extra query latency. Maximum number of keys is 30.
For FulfillmentInfo, a fulfillment type and a fulfillment ID must be provided in the format of "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is the store ID.
Supported keys are:
- colorFamilies
- price
- originalPrice
- discount
- variantId
- inventory(place_id,price)
- inventory(place_id,original_price)
- inventory(place_id,attributes.key), where key is any key in the Product.local_inventories.attributes map.
- attributes.key, where key is any key in the Product.attributes map.
- pickupInStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store".
- shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "ship-to-store".
- sameDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "same-day-delivery".
- nextDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-delivery".
- customFulfillment1.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-1".
- customFulfillment2.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2".
- customFulfillment3.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-3".
- customFulfillment4.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4".
customFulfillment5.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-5".
If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.
repeated string variant_rollup_keys = 17;
Parameter | |
---|---|
Name | Description |
index | int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String | The variantRollupKeys at the given index. |
getVariantRollupKeysBytes(int index)
public ByteString getVariantRollupKeysBytes(int index)
The keys to fetch and rollup the matching variant Products attributes, FulfillmentInfo or LocalInventorys attributes. The attributes from all the matching variant Products or LocalInventorys are merged and de-duplicated. Notice that rollup attributes will lead to extra query latency. Maximum number of keys is 30.
For FulfillmentInfo, a fulfillment type and a fulfillment ID must be provided in the format of "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is the store ID.
Supported keys are:
- colorFamilies
- price
- originalPrice
- discount
- variantId
- inventory(place_id,price)
- inventory(place_id,original_price)
- inventory(place_id,attributes.key), where key is any key in the Product.local_inventories.attributes map.
- attributes.key, where key is any key in the Product.attributes map.
- pickupInStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store".
- shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "ship-to-store".
- sameDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "same-day-delivery".
- nextDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-delivery".
- customFulfillment1.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-1".
- customFulfillment2.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2".
- customFulfillment3.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-3".
- customFulfillment4.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4".
customFulfillment5.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-5".
If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.
repeated string variant_rollup_keys = 17;
Parameter | |
---|---|
Name | Description |
index | int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString | The bytes of the variantRollupKeys at the given index. |
getVariantRollupKeysCount()
public int getVariantRollupKeysCount()
The keys to fetch and rollup the matching variant Products attributes, FulfillmentInfo or LocalInventorys attributes. The attributes from all the matching variant Products or LocalInventorys are merged and de-duplicated. Notice that rollup attributes will lead to extra query latency. Maximum number of keys is 30.
For FulfillmentInfo, a fulfillment type and a fulfillment ID must be provided in the format of "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is the store ID.
Supported keys are:
- colorFamilies
- price
- originalPrice
- discount
- variantId
- inventory(place_id,price)
- inventory(place_id,original_price)
- inventory(place_id,attributes.key), where key is any key in the Product.local_inventories.attributes map.
- attributes.key, where key is any key in the Product.attributes map.
- pickupInStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store".
- shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "ship-to-store".
- sameDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "same-day-delivery".
- nextDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-delivery".
- customFulfillment1.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-1".
- customFulfillment2.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2".
- customFulfillment3.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-3".
- customFulfillment4.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4".
customFulfillment5.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-5".
If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.
repeated string variant_rollup_keys = 17;
Returns | |
---|---|
Type | Description |
int | The count of variantRollupKeys. |
getVariantRollupKeysList()
public ProtocolStringList getVariantRollupKeysList()
The keys to fetch and rollup the matching variant Products attributes, FulfillmentInfo or LocalInventorys attributes. The attributes from all the matching variant Products or LocalInventorys are merged and de-duplicated. Notice that rollup attributes will lead to extra query latency. Maximum number of keys is 30.
For FulfillmentInfo, a fulfillment type and a fulfillment ID must be provided in the format of "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is the store ID.
Supported keys are:
- colorFamilies
- price
- originalPrice
- discount
- variantId
- inventory(place_id,price)
- inventory(place_id,original_price)
- inventory(place_id,attributes.key), where key is any key in the Product.local_inventories.attributes map.
- attributes.key, where key is any key in the Product.attributes map.
- pickupInStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "pickup-in-store".
- shipToStore.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "ship-to-store".
- sameDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "same-day-delivery".
- nextDayDelivery.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "next-day-delivery".
- customFulfillment1.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-1".
- customFulfillment2.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-2".
- customFulfillment3.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-3".
- customFulfillment4.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-4".
customFulfillment5.id, where id is any FulfillmentInfo.place_ids for FulfillmentInfo.type "custom-type-5".
If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.
repeated string variant_rollup_keys = 17;
Returns | |
---|---|
Type | Description |
ProtocolStringList | A list containing the variantRollupKeys. |
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 = 4 [(.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 = 4 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for visitorId. |
hasBoostSpec()
public boolean hasBoostSpec()
Boost specification to boost certain products. See more details at this user guide.
Notice that if both ServingConfig.boost_control_ids and SearchRequest.boost_spec are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the final boost score is equal to the sum of the boost scores from all matched boost conditions.
.google.cloud.retail.v2beta.SearchRequest.BoostSpec boost_spec = 13;
Returns | |
---|---|
Type | Description |
boolean | Whether the boostSpec field is set. |
hasDynamicFacetSpec() (deprecated)
public boolean hasDynamicFacetSpec()
Deprecated. google.cloud.retail.v2beta.SearchRequest.dynamic_facet_spec is deprecated. See google/cloud/retail/v2beta/search_service.proto;l=599
Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets. Do not set this field.
The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated.
.google.cloud.retail.v2beta.SearchRequest.DynamicFacetSpec dynamic_facet_spec = 21 [deprecated = true];
Returns | |
---|---|
Type | Description |
boolean | Whether the dynamicFacetSpec field is set. |
hasPersonalizationSpec()
public boolean hasPersonalizationSpec()
The specification for personalization.
Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set. SearchRequest.personalization_spec will override ServingConfig.personalization_spec.
.google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec personalization_spec = 32;
Returns | |
---|---|
Type | Description |
boolean | Whether the personalizationSpec field is set. |
hasQueryExpansionSpec()
public boolean hasQueryExpansionSpec()
The query expansion specification that specifies the conditions under which query expansion will occur. See more details at this user guide.
.google.cloud.retail.v2beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 14;
Returns | |
---|---|
Type | Description |
boolean | Whether the queryExpansionSpec field is set. |
hasSpellCorrectionSpec()
public boolean hasSpellCorrectionSpec()
The spell correction specification that specifies the mode under which spell correction will take effect.
optional .google.cloud.retail.v2beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 35;
Returns | |
---|---|
Type | Description |
boolean | Whether the spellCorrectionSpec field is set. |
hasUserInfo()
public boolean hasUserInfo()
User information.
.google.cloud.retail.v2beta.UserInfo user_info = 5;
Returns | |
---|---|
Type | Description |
boolean | Whether the userInfo field is set. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter | |
---|---|
Name | Description |
number | int |
Returns | |
---|---|
Type | Description |
MapField |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public SearchRequest.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent | BuilderParent |
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused | UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public SearchRequest.Builder toBuilder()
Returns | |
---|---|
Type | Description |
SearchRequest.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output | CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |