Package com.google.cloud.retail.v2alpha
Interface SearchResponse.SearchResultOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
SearchResponse.SearchResult,SearchResponse.SearchResult.Builder
- Enclosing class:
- SearchResponse
public static interface SearchResponse.SearchResultOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleanIf a [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product] matches the search query, this map indicates which [Product][google.cloud.retail.v2alpha.Product] fields are matched.booleanGoogle provided available scores.booleanThe rollup matching [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product] attributes.getId()[Product.id][google.cloud.retail.v2alpha.Product.id] of the searched [Product][google.cloud.retail.v2alpha.Product].com.google.protobuf.ByteString[Product.id][google.cloud.retail.v2alpha.Product.id] of the searched [Product][google.cloud.retail.v2alpha.Product].intThe count of matched [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product]s.Deprecated.intIf a [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product] matches the search query, this map indicates which [Product][google.cloud.retail.v2alpha.Product] fields are matched.If a [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product] matches the search query, this map indicates which [Product][google.cloud.retail.v2alpha.Product] fields are matched.com.google.protobuf.FieldMaskgetMatchingVariantFieldsOrDefault(String key, com.google.protobuf.FieldMask defaultValue) If a [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product] matches the search query, this map indicates which [Product][google.cloud.retail.v2alpha.Product] fields are matched.com.google.protobuf.FieldMaskIf a [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product] matches the search query, this map indicates which [Product][google.cloud.retail.v2alpha.Product] fields are matched.Deprecated.intGoogle provided available scores.Google provided available scores.getModelScoresOrDefault(String key, DoubleList defaultValue) Google provided available scores.Google provided available scores.getPersonalLabels(int index) Specifies previous events related to this product for this user based on [UserEvent][google.cloud.retail.v2alpha.UserEvent] with same [SearchRequest.visitor_id][google.cloud.retail.v2alpha.SearchRequest.visitor_id] or [UserInfo.user_id][google.cloud.retail.v2alpha.UserInfo.user_id].com.google.protobuf.ByteStringgetPersonalLabelsBytes(int index) Specifies previous events related to this product for this user based on [UserEvent][google.cloud.retail.v2alpha.UserEvent] with same [SearchRequest.visitor_id][google.cloud.retail.v2alpha.SearchRequest.visitor_id] or [UserInfo.user_id][google.cloud.retail.v2alpha.UserInfo.user_id].intSpecifies previous events related to this product for this user based on [UserEvent][google.cloud.retail.v2alpha.UserEvent] with same [SearchRequest.visitor_id][google.cloud.retail.v2alpha.SearchRequest.visitor_id] or [UserInfo.user_id][google.cloud.retail.v2alpha.UserInfo.user_id].Specifies previous events related to this product for this user based on [UserEvent][google.cloud.retail.v2alpha.UserEvent] with same [SearchRequest.visitor_id][google.cloud.retail.v2alpha.SearchRequest.visitor_id] or [UserInfo.user_id][google.cloud.retail.v2alpha.UserInfo.user_id].The product data snippet in the search response.The product data snippet in the search response.Deprecated.intThe rollup matching [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product] attributes.The rollup matching [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product] attributes.com.google.protobuf.ValuegetVariantRollupValuesOrDefault(String key, com.google.protobuf.Value defaultValue) The rollup matching [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product] attributes.com.google.protobuf.ValueThe rollup matching [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product] attributes.booleanThe product data snippet in the search response.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getId
String getId()[Product.id][google.cloud.retail.v2alpha.Product.id] of the searched [Product][google.cloud.retail.v2alpha.Product].
string id = 1;- Returns:
- The id.
-
getIdBytes
com.google.protobuf.ByteString getIdBytes()[Product.id][google.cloud.retail.v2alpha.Product.id] of the searched [Product][google.cloud.retail.v2alpha.Product].
string id = 1;- Returns:
- The bytes for id.
-
hasProduct
boolean hasProduct()The product data snippet in the search response. Only [Product.name][google.cloud.retail.v2alpha.Product.name] is guaranteed to be populated. [Product.variants][google.cloud.retail.v2alpha.Product.variants] contains the product variants that match the search query. If there are multiple product variants matching the query, top 5 most relevant product variants are returned and ordered by relevancy. If relevancy can be deternmined, use [matching_variant_fields][google.cloud.retail.v2alpha.SearchResponse.SearchResult.matching_variant_fields] to look up matched product variants fields. If relevancy cannot be determined, e.g. when searching "shoe" all products in a shoe product can be a match, 5 product variants are returned but order is meaningless.
.google.cloud.retail.v2alpha.Product product = 2;- Returns:
- Whether the product field is set.
-
getProduct
Product getProduct()The product data snippet in the search response. Only [Product.name][google.cloud.retail.v2alpha.Product.name] is guaranteed to be populated. [Product.variants][google.cloud.retail.v2alpha.Product.variants] contains the product variants that match the search query. If there are multiple product variants matching the query, top 5 most relevant product variants are returned and ordered by relevancy. If relevancy can be deternmined, use [matching_variant_fields][google.cloud.retail.v2alpha.SearchResponse.SearchResult.matching_variant_fields] to look up matched product variants fields. If relevancy cannot be determined, e.g. when searching "shoe" all products in a shoe product can be a match, 5 product variants are returned but order is meaningless.
.google.cloud.retail.v2alpha.Product product = 2;- Returns:
- The product.
-
getProductOrBuilder
ProductOrBuilder getProductOrBuilder()The product data snippet in the search response. Only [Product.name][google.cloud.retail.v2alpha.Product.name] is guaranteed to be populated. [Product.variants][google.cloud.retail.v2alpha.Product.variants] contains the product variants that match the search query. If there are multiple product variants matching the query, top 5 most relevant product variants are returned and ordered by relevancy. If relevancy can be deternmined, use [matching_variant_fields][google.cloud.retail.v2alpha.SearchResponse.SearchResult.matching_variant_fields] to look up matched product variants fields. If relevancy cannot be determined, e.g. when searching "shoe" all products in a shoe product can be a match, 5 product variants are returned but order is meaningless.
.google.cloud.retail.v2alpha.Product product = 2; -
getMatchingVariantCount
int getMatchingVariantCount()The count of matched [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product]s.
int32 matching_variant_count = 3;- Returns:
- The matchingVariantCount.
-
getMatchingVariantFieldsCount
int getMatchingVariantFieldsCount()If a [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product] matches the search query, this map indicates which [Product][google.cloud.retail.v2alpha.Product] fields are matched. The key is the [Product.name][google.cloud.retail.v2alpha.Product.name], the value is a field mask of the matched [Product][google.cloud.retail.v2alpha.Product] fields. If matched attributes cannot be determined, this map will be empty. For example, a key "sku1" with field mask "products.color_info" indicates there is a match between "sku1" [ColorInfo][google.cloud.retail.v2alpha.ColorInfo] and the query.
map<string, .google.protobuf.FieldMask> matching_variant_fields = 4; -
containsMatchingVariantFields
If a [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product] matches the search query, this map indicates which [Product][google.cloud.retail.v2alpha.Product] fields are matched. The key is the [Product.name][google.cloud.retail.v2alpha.Product.name], the value is a field mask of the matched [Product][google.cloud.retail.v2alpha.Product] fields. If matched attributes cannot be determined, this map will be empty. For example, a key "sku1" with field mask "products.color_info" indicates there is a match between "sku1" [ColorInfo][google.cloud.retail.v2alpha.ColorInfo] and the query.
map<string, .google.protobuf.FieldMask> matching_variant_fields = 4; -
getMatchingVariantFields
Deprecated.UsegetMatchingVariantFieldsMap()instead. -
getMatchingVariantFieldsMap
If a [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product] matches the search query, this map indicates which [Product][google.cloud.retail.v2alpha.Product] fields are matched. The key is the [Product.name][google.cloud.retail.v2alpha.Product.name], the value is a field mask of the matched [Product][google.cloud.retail.v2alpha.Product] fields. If matched attributes cannot be determined, this map will be empty. For example, a key "sku1" with field mask "products.color_info" indicates there is a match between "sku1" [ColorInfo][google.cloud.retail.v2alpha.ColorInfo] and the query.
map<string, .google.protobuf.FieldMask> matching_variant_fields = 4; -
getMatchingVariantFieldsOrDefault
com.google.protobuf.FieldMask getMatchingVariantFieldsOrDefault(String key, com.google.protobuf.FieldMask defaultValue) If a [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product] matches the search query, this map indicates which [Product][google.cloud.retail.v2alpha.Product] fields are matched. The key is the [Product.name][google.cloud.retail.v2alpha.Product.name], the value is a field mask of the matched [Product][google.cloud.retail.v2alpha.Product] fields. If matched attributes cannot be determined, this map will be empty. For example, a key "sku1" with field mask "products.color_info" indicates there is a match between "sku1" [ColorInfo][google.cloud.retail.v2alpha.ColorInfo] and the query.
map<string, .google.protobuf.FieldMask> matching_variant_fields = 4; -
getMatchingVariantFieldsOrThrow
If a [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product] matches the search query, this map indicates which [Product][google.cloud.retail.v2alpha.Product] fields are matched. The key is the [Product.name][google.cloud.retail.v2alpha.Product.name], the value is a field mask of the matched [Product][google.cloud.retail.v2alpha.Product] fields. If matched attributes cannot be determined, this map will be empty. For example, a key "sku1" with field mask "products.color_info" indicates there is a match between "sku1" [ColorInfo][google.cloud.retail.v2alpha.ColorInfo] and the query.
map<string, .google.protobuf.FieldMask> matching_variant_fields = 4; -
getVariantRollupValuesCount
int getVariantRollupValuesCount()The rollup matching [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product] attributes. The key is one of the [SearchRequest.variant_rollup_keys][google.cloud.retail.v2alpha.SearchRequest.variant_rollup_keys]. The values are the merged and de-duplicated [Product][google.cloud.retail.v2alpha.Product] attributes. Notice that the rollup values are respect filter. For example, when filtering by "colorFamilies:ANY(\"red\")" and rollup "colorFamilies", only "red" is returned. For textual and numerical attributes, the rollup values is a list of string or double values with type [google.protobuf.ListValue][google.protobuf.ListValue]. For example, if there are two variants with colors "red" and "blue", the rollup values are { key: "colorFamilies" value { list_value { values { string_value: "red" } values { string_value: "blue" } } } } For [FulfillmentInfo][google.cloud.retail.v2alpha.FulfillmentInfo], the rollup values is a double value with type [google.protobuf.Value][google.protobuf.Value]. For example, `{key: "pickupInStore.store1" value { number_value: 10 }}` means a there are 10 variants in this product are available in the store "store1".map<string, .google.protobuf.Value> variant_rollup_values = 5; -
containsVariantRollupValues
The rollup matching [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product] attributes. The key is one of the [SearchRequest.variant_rollup_keys][google.cloud.retail.v2alpha.SearchRequest.variant_rollup_keys]. The values are the merged and de-duplicated [Product][google.cloud.retail.v2alpha.Product] attributes. Notice that the rollup values are respect filter. For example, when filtering by "colorFamilies:ANY(\"red\")" and rollup "colorFamilies", only "red" is returned. For textual and numerical attributes, the rollup values is a list of string or double values with type [google.protobuf.ListValue][google.protobuf.ListValue]. For example, if there are two variants with colors "red" and "blue", the rollup values are { key: "colorFamilies" value { list_value { values { string_value: "red" } values { string_value: "blue" } } } } For [FulfillmentInfo][google.cloud.retail.v2alpha.FulfillmentInfo], the rollup values is a double value with type [google.protobuf.Value][google.protobuf.Value]. For example, `{key: "pickupInStore.store1" value { number_value: 10 }}` means a there are 10 variants in this product are available in the store "store1".map<string, .google.protobuf.Value> variant_rollup_values = 5; -
getVariantRollupValues
Deprecated.UsegetVariantRollupValuesMap()instead. -
getVariantRollupValuesMap
The rollup matching [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product] attributes. The key is one of the [SearchRequest.variant_rollup_keys][google.cloud.retail.v2alpha.SearchRequest.variant_rollup_keys]. The values are the merged and de-duplicated [Product][google.cloud.retail.v2alpha.Product] attributes. Notice that the rollup values are respect filter. For example, when filtering by "colorFamilies:ANY(\"red\")" and rollup "colorFamilies", only "red" is returned. For textual and numerical attributes, the rollup values is a list of string or double values with type [google.protobuf.ListValue][google.protobuf.ListValue]. For example, if there are two variants with colors "red" and "blue", the rollup values are { key: "colorFamilies" value { list_value { values { string_value: "red" } values { string_value: "blue" } } } } For [FulfillmentInfo][google.cloud.retail.v2alpha.FulfillmentInfo], the rollup values is a double value with type [google.protobuf.Value][google.protobuf.Value]. For example, `{key: "pickupInStore.store1" value { number_value: 10 }}` means a there are 10 variants in this product are available in the store "store1".map<string, .google.protobuf.Value> variant_rollup_values = 5; -
getVariantRollupValuesOrDefault
com.google.protobuf.Value getVariantRollupValuesOrDefault(String key, com.google.protobuf.Value defaultValue) The rollup matching [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product] attributes. The key is one of the [SearchRequest.variant_rollup_keys][google.cloud.retail.v2alpha.SearchRequest.variant_rollup_keys]. The values are the merged and de-duplicated [Product][google.cloud.retail.v2alpha.Product] attributes. Notice that the rollup values are respect filter. For example, when filtering by "colorFamilies:ANY(\"red\")" and rollup "colorFamilies", only "red" is returned. For textual and numerical attributes, the rollup values is a list of string or double values with type [google.protobuf.ListValue][google.protobuf.ListValue]. For example, if there are two variants with colors "red" and "blue", the rollup values are { key: "colorFamilies" value { list_value { values { string_value: "red" } values { string_value: "blue" } } } } For [FulfillmentInfo][google.cloud.retail.v2alpha.FulfillmentInfo], the rollup values is a double value with type [google.protobuf.Value][google.protobuf.Value]. For example, `{key: "pickupInStore.store1" value { number_value: 10 }}` means a there are 10 variants in this product are available in the store "store1".map<string, .google.protobuf.Value> variant_rollup_values = 5; -
getVariantRollupValuesOrThrow
The rollup matching [variant][google.cloud.retail.v2alpha.Product.Type.VARIANT] [Product][google.cloud.retail.v2alpha.Product] attributes. The key is one of the [SearchRequest.variant_rollup_keys][google.cloud.retail.v2alpha.SearchRequest.variant_rollup_keys]. The values are the merged and de-duplicated [Product][google.cloud.retail.v2alpha.Product] attributes. Notice that the rollup values are respect filter. For example, when filtering by "colorFamilies:ANY(\"red\")" and rollup "colorFamilies", only "red" is returned. For textual and numerical attributes, the rollup values is a list of string or double values with type [google.protobuf.ListValue][google.protobuf.ListValue]. For example, if there are two variants with colors "red" and "blue", the rollup values are { key: "colorFamilies" value { list_value { values { string_value: "red" } values { string_value: "blue" } } } } For [FulfillmentInfo][google.cloud.retail.v2alpha.FulfillmentInfo], the rollup values is a double value with type [google.protobuf.Value][google.protobuf.Value]. For example, `{key: "pickupInStore.store1" value { number_value: 10 }}` means a there are 10 variants in this product are available in the store "store1".map<string, .google.protobuf.Value> variant_rollup_values = 5; -
getPersonalLabelsList
Specifies previous events related to this product for this user based on [UserEvent][google.cloud.retail.v2alpha.UserEvent] with same [SearchRequest.visitor_id][google.cloud.retail.v2alpha.SearchRequest.visitor_id] or [UserInfo.user_id][google.cloud.retail.v2alpha.UserInfo.user_id]. This is set only when [SearchRequest.PersonalizationSpec.mode][google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec.mode] is [SearchRequest.PersonalizationSpec.Mode.AUTO][google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec.Mode.AUTO]. Possible values: * `purchased`: Indicates that this product has been purchased before.
repeated string personal_labels = 7;- Returns:
- A list containing the personalLabels.
-
getPersonalLabelsCount
int getPersonalLabelsCount()Specifies previous events related to this product for this user based on [UserEvent][google.cloud.retail.v2alpha.UserEvent] with same [SearchRequest.visitor_id][google.cloud.retail.v2alpha.SearchRequest.visitor_id] or [UserInfo.user_id][google.cloud.retail.v2alpha.UserInfo.user_id]. This is set only when [SearchRequest.PersonalizationSpec.mode][google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec.mode] is [SearchRequest.PersonalizationSpec.Mode.AUTO][google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec.Mode.AUTO]. Possible values: * `purchased`: Indicates that this product has been purchased before.
repeated string personal_labels = 7;- Returns:
- The count of personalLabels.
-
getPersonalLabels
Specifies previous events related to this product for this user based on [UserEvent][google.cloud.retail.v2alpha.UserEvent] with same [SearchRequest.visitor_id][google.cloud.retail.v2alpha.SearchRequest.visitor_id] or [UserInfo.user_id][google.cloud.retail.v2alpha.UserInfo.user_id]. This is set only when [SearchRequest.PersonalizationSpec.mode][google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec.mode] is [SearchRequest.PersonalizationSpec.Mode.AUTO][google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec.Mode.AUTO]. Possible values: * `purchased`: Indicates that this product has been purchased before.
repeated string personal_labels = 7;- Parameters:
index- The index of the element to return.- Returns:
- The personalLabels at the given index.
-
getPersonalLabelsBytes
com.google.protobuf.ByteString getPersonalLabelsBytes(int index) Specifies previous events related to this product for this user based on [UserEvent][google.cloud.retail.v2alpha.UserEvent] with same [SearchRequest.visitor_id][google.cloud.retail.v2alpha.SearchRequest.visitor_id] or [UserInfo.user_id][google.cloud.retail.v2alpha.UserInfo.user_id]. This is set only when [SearchRequest.PersonalizationSpec.mode][google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec.mode] is [SearchRequest.PersonalizationSpec.Mode.AUTO][google.cloud.retail.v2alpha.SearchRequest.PersonalizationSpec.Mode.AUTO]. Possible values: * `purchased`: Indicates that this product has been purchased before.
repeated string personal_labels = 7;- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the personalLabels at the given index.
-
getModelScoresCount
int getModelScoresCount()Google provided available scores.
map<string, .google.cloud.retail.v2alpha.DoubleList> model_scores = 8; -
containsModelScores
Google provided available scores.
map<string, .google.cloud.retail.v2alpha.DoubleList> model_scores = 8; -
getModelScores
Deprecated.UsegetModelScoresMap()instead. -
getModelScoresMap
Map<String,DoubleList> getModelScoresMap()Google provided available scores.
map<string, .google.cloud.retail.v2alpha.DoubleList> model_scores = 8; -
getModelScoresOrDefault
Google provided available scores.
map<string, .google.cloud.retail.v2alpha.DoubleList> model_scores = 8; -
getModelScoresOrThrow
Google provided available scores.
map<string, .google.cloud.retail.v2alpha.DoubleList> model_scores = 8;
-