public static final class SearchResponse.SearchResult.Builder extends GeneratedMessageV3.Builder<SearchResponse.SearchResult.Builder> implements SearchResponse.SearchResultOrBuilderRepresents the search results.
Protobuf type google.cloud.retail.v2.SearchResponse.SearchResult
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchResponse.SearchResult.BuilderImplements
SearchResponse.SearchResultOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllPersonalLabels(Iterable<String> values)
public SearchResponse.SearchResult.Builder addAllPersonalLabels(Iterable<String> values)Specifies previous events related to this product for this user based on UserEvent with same SearchRequest.visitor_id or UserInfo.user_id.
This is set only when SearchRequest.PersonalizationSpec.mode is SearchRequest.PersonalizationSpec.Mode.AUTO.
Possible values:
purchased: Indicates that this product has been purchased before.
repeated string personal_labels = 7;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<String>The personalLabels to add. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | This builder for chaining. |
addPersonalLabels(String value)
public SearchResponse.SearchResult.Builder addPersonalLabels(String value)Specifies previous events related to this product for this user based on UserEvent with same SearchRequest.visitor_id or UserInfo.user_id.
This is set only when SearchRequest.PersonalizationSpec.mode is SearchRequest.PersonalizationSpec.Mode.AUTO.
Possible values:
purchased: Indicates that this product has been purchased before.
repeated string personal_labels = 7;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe personalLabels to add. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | This builder for chaining. |
addPersonalLabelsBytes(ByteString value)
public SearchResponse.SearchResult.Builder addPersonalLabelsBytes(ByteString value)Specifies previous events related to this product for this user based on UserEvent with same SearchRequest.visitor_id or UserInfo.user_id.
This is set only when SearchRequest.PersonalizationSpec.mode is SearchRequest.PersonalizationSpec.Mode.AUTO.
Possible values:
purchased: Indicates that this product has been purchased before.
repeated string personal_labels = 7;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes of the personalLabels to add. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchResponse.SearchResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
build()
public SearchResponse.SearchResult build()| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult | |
buildPartial()
public SearchResponse.SearchResult buildPartial()| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult | |
clear()
public SearchResponse.SearchResult.Builder clear()| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
clearField(Descriptors.FieldDescriptor field)
public SearchResponse.SearchResult.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
clearId()
public SearchResponse.SearchResult.Builder clearId()Product.id of the searched Product.
string id = 1;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | This builder for chaining. |
clearMatchingVariantCount()
public SearchResponse.SearchResult.Builder clearMatchingVariantCount()The count of matched variant Products.
int32 matching_variant_count = 3;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | This builder for chaining. |
clearMatchingVariantFields()
public SearchResponse.SearchResult.Builder clearMatchingVariantFields()| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchResponse.SearchResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
clearPersonalLabels()
public SearchResponse.SearchResult.Builder clearPersonalLabels()Specifies previous events related to this product for this user based on UserEvent with same SearchRequest.visitor_id or UserInfo.user_id.
This is set only when SearchRequest.PersonalizationSpec.mode is SearchRequest.PersonalizationSpec.Mode.AUTO.
Possible values:
purchased: Indicates that this product has been purchased before.
repeated string personal_labels = 7;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | This builder for chaining. |
clearProduct()
public SearchResponse.SearchResult.Builder clearProduct()The product data snippet in the search response. Only Product.name is guaranteed to be populated.
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 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.v2.Product product = 2;
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
clearVariantRollupValues()
public SearchResponse.SearchResult.Builder clearVariantRollupValues()| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
clone()
public SearchResponse.SearchResult.Builder clone()| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
containsMatchingVariantFields(String key)
public boolean containsMatchingVariantFields(String key)If a variant Product matches the search query, this map indicates which Product fields are matched. The key is the Product.name, the value is a field mask of the matched 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 and the query.
map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
containsVariantRollupValues(String key)
public boolean containsVariantRollupValues(String key)The rollup matching variant Product attributes. The key is one of the SearchRequest.variant_rollup_keys. The values are the merged and de-duplicated 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. 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, the rollup
values is a double value with type
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;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getDefaultInstanceForType()
public SearchResponse.SearchResult getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getId()
public String getId()Product.id of the searched Product.
string id = 1;
| Returns | |
|---|---|
| Type | Description |
String | The id. |
getIdBytes()
public ByteString getIdBytes()Product.id of the searched Product.
string id = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for id. |
getMatchingVariantCount()
public int getMatchingVariantCount()The count of matched variant Products.
int32 matching_variant_count = 3;
| Returns | |
|---|---|
| Type | Description |
int | The matchingVariantCount. |
getMatchingVariantFields() (deprecated)
public Map<String,FieldMask> getMatchingVariantFields()Use #getMatchingVariantFieldsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,FieldMask> | |
getMatchingVariantFieldsCount()
public int getMatchingVariantFieldsCount()If a variant Product matches the search query, this map indicates which Product fields are matched. The key is the Product.name, the value is a field mask of the matched 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 and the query.
map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;
| Returns | |
|---|---|
| Type | Description |
int | |
getMatchingVariantFieldsMap()
public Map<String,FieldMask> getMatchingVariantFieldsMap()If a variant Product matches the search query, this map indicates which Product fields are matched. The key is the Product.name, the value is a field mask of the matched 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 and the query.
map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;
| Returns | |
|---|---|
| Type | Description |
Map<String,FieldMask> | |
getMatchingVariantFieldsOrDefault(String key, FieldMask defaultValue)
public FieldMask getMatchingVariantFieldsOrDefault(String key, FieldMask defaultValue)If a variant Product matches the search query, this map indicates which Product fields are matched. The key is the Product.name, the value is a field mask of the matched 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 and the query.
map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | FieldMask |
| Returns | |
|---|---|
| Type | Description |
FieldMask | |
getMatchingVariantFieldsOrThrow(String key)
public FieldMask getMatchingVariantFieldsOrThrow(String key)If a variant Product matches the search query, this map indicates which Product fields are matched. The key is the Product.name, the value is a field mask of the matched 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 and the query.
map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
FieldMask | |
getMutableMatchingVariantFields() (deprecated)
public Map<String,FieldMask> getMutableMatchingVariantFields()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,FieldMask> | |
getMutableVariantRollupValues() (deprecated)
public Map<String,Value> getMutableVariantRollupValues()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Value> | |
getPersonalLabels(int index)
public String getPersonalLabels(int index)Specifies previous events related to this product for this user based on UserEvent with same SearchRequest.visitor_id or UserInfo.user_id.
This is set only when SearchRequest.PersonalizationSpec.mode is SearchRequest.PersonalizationSpec.Mode.AUTO.
Possible values:
purchased: Indicates that this product has been purchased before.
repeated string personal_labels = 7;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The personalLabels at the given index. |
getPersonalLabelsBytes(int index)
public ByteString getPersonalLabelsBytes(int index)Specifies previous events related to this product for this user based on UserEvent with same SearchRequest.visitor_id or UserInfo.user_id.
This is set only when SearchRequest.PersonalizationSpec.mode is SearchRequest.PersonalizationSpec.Mode.AUTO.
Possible values:
purchased: Indicates that this product has been purchased before.
repeated string personal_labels = 7;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the personalLabels at the given index. |
getPersonalLabelsCount()
public int getPersonalLabelsCount()Specifies previous events related to this product for this user based on UserEvent with same SearchRequest.visitor_id or UserInfo.user_id.
This is set only when SearchRequest.PersonalizationSpec.mode is SearchRequest.PersonalizationSpec.Mode.AUTO.
Possible values:
purchased: Indicates that this product has been purchased before.
repeated string personal_labels = 7;
| Returns | |
|---|---|
| Type | Description |
int | The count of personalLabels. |
getPersonalLabelsList()
public ProtocolStringList getPersonalLabelsList()Specifies previous events related to this product for this user based on UserEvent with same SearchRequest.visitor_id or UserInfo.user_id.
This is set only when SearchRequest.PersonalizationSpec.mode is SearchRequest.PersonalizationSpec.Mode.AUTO.
Possible values:
purchased: Indicates that this product has been purchased before.
repeated string personal_labels = 7;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList | A list containing the personalLabels. |
getProduct()
public Product getProduct()The product data snippet in the search response. Only Product.name is guaranteed to be populated.
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 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.v2.Product product = 2;
| Returns | |
|---|---|
| Type | Description |
Product | The product. |
getProductBuilder()
public Product.Builder getProductBuilder()The product data snippet in the search response. Only Product.name is guaranteed to be populated.
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 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.v2.Product product = 2;
| Returns | |
|---|---|
| Type | Description |
Product.Builder | |
getProductOrBuilder()
public ProductOrBuilder getProductOrBuilder()The product data snippet in the search response. Only Product.name is guaranteed to be populated.
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 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.v2.Product product = 2;
| Returns | |
|---|---|
| Type | Description |
ProductOrBuilder | |
getVariantRollupValues() (deprecated)
public Map<String,Value> getVariantRollupValues()Use #getVariantRollupValuesMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Value> | |
getVariantRollupValuesCount()
public int getVariantRollupValuesCount()The rollup matching variant Product attributes. The key is one of the SearchRequest.variant_rollup_keys. The values are the merged and de-duplicated 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. 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, the rollup
values is a double value with type
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;
| Returns | |
|---|---|
| Type | Description |
int | |
getVariantRollupValuesMap()
public Map<String,Value> getVariantRollupValuesMap()The rollup matching variant Product attributes. The key is one of the SearchRequest.variant_rollup_keys. The values are the merged and de-duplicated 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. 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, the rollup
values is a double value with type
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;
| Returns | |
|---|---|
| Type | Description |
Map<String,Value> | |
getVariantRollupValuesOrDefault(String key, Value defaultValue)
public Value getVariantRollupValuesOrDefault(String key, Value defaultValue)The rollup matching variant Product attributes. The key is one of the SearchRequest.variant_rollup_keys. The values are the merged and de-duplicated 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. 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, the rollup
values is a double value with type
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;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | Value |
| Returns | |
|---|---|
| Type | Description |
Value | |
getVariantRollupValuesOrThrow(String key)
public Value getVariantRollupValuesOrThrow(String key)The rollup matching variant Product attributes. The key is one of the SearchRequest.variant_rollup_keys. The values are the merged and de-duplicated 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. 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, the rollup
values is a double value with type
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;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
Value | |
hasProduct()
public boolean hasProduct()The product data snippet in the search response. Only Product.name is guaranteed to be populated.
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 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.v2.Product product = 2;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the product field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(SearchResponse.SearchResult other)
public SearchResponse.SearchResult.Builder mergeFrom(SearchResponse.SearchResult other)| Parameter | |
|---|---|
| Name | Description |
other | SearchResponse.SearchResult |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchResponse.SearchResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public SearchResponse.SearchResult.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
mergeProduct(Product value)
public SearchResponse.SearchResult.Builder mergeProduct(Product value)The product data snippet in the search response. Only Product.name is guaranteed to be populated.
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 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.v2.Product product = 2;
| Parameter | |
|---|---|
| Name | Description |
value | Product |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchResponse.SearchResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
putAllMatchingVariantFields(Map<String,FieldMask> values)
public SearchResponse.SearchResult.Builder putAllMatchingVariantFields(Map<String,FieldMask> values)If a variant Product matches the search query, this map indicates which Product fields are matched. The key is the Product.name, the value is a field mask of the matched 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 and the query.
map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;
| Parameter | |
|---|---|
| Name | Description |
values | Map<String,FieldMask> |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
putAllVariantRollupValues(Map<String,Value> values)
public SearchResponse.SearchResult.Builder putAllVariantRollupValues(Map<String,Value> values)The rollup matching variant Product attributes. The key is one of the SearchRequest.variant_rollup_keys. The values are the merged and de-duplicated 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. 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, the rollup
values is a double value with type
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;
| Parameter | |
|---|---|
| Name | Description |
values | Map<String,Value> |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
putMatchingVariantFields(String key, FieldMask value)
public SearchResponse.SearchResult.Builder putMatchingVariantFields(String key, FieldMask value)If a variant Product matches the search query, this map indicates which Product fields are matched. The key is the Product.name, the value is a field mask of the matched 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 and the query.
map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | FieldMask |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
putMatchingVariantFieldsBuilderIfAbsent(String key)
public FieldMask.Builder putMatchingVariantFieldsBuilderIfAbsent(String key)If a variant Product matches the search query, this map indicates which Product fields are matched. The key is the Product.name, the value is a field mask of the matched 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 and the query.
map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
Builder | |
putVariantRollupValues(String key, Value value)
public SearchResponse.SearchResult.Builder putVariantRollupValues(String key, Value value)The rollup matching variant Product attributes. The key is one of the SearchRequest.variant_rollup_keys. The values are the merged and de-duplicated 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. 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, the rollup
values is a double value with type
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;
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | Value |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
putVariantRollupValuesBuilderIfAbsent(String key)
public Value.Builder putVariantRollupValuesBuilderIfAbsent(String key)The rollup matching variant Product attributes. The key is one of the SearchRequest.variant_rollup_keys. The values are the merged and de-duplicated 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. 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, the rollup
values is a double value with type
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;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
Builder | |
removeMatchingVariantFields(String key)
public SearchResponse.SearchResult.Builder removeMatchingVariantFields(String key)If a variant Product matches the search query, this map indicates which Product fields are matched. The key is the Product.name, the value is a field mask of the matched 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 and the query.
map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
removeVariantRollupValues(String key)
public SearchResponse.SearchResult.Builder removeVariantRollupValues(String key)The rollup matching variant Product attributes. The key is one of the SearchRequest.variant_rollup_keys. The values are the merged and de-duplicated 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. 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, the rollup
values is a double value with type
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;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public SearchResponse.SearchResult.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
setId(String value)
public SearchResponse.SearchResult.Builder setId(String value)Product.id of the searched Product.
string id = 1;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe id to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | This builder for chaining. |
setIdBytes(ByteString value)
public SearchResponse.SearchResult.Builder setIdBytes(ByteString value)Product.id of the searched Product.
string id = 1;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for id to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | This builder for chaining. |
setMatchingVariantCount(int value)
public SearchResponse.SearchResult.Builder setMatchingVariantCount(int value)The count of matched variant Products.
int32 matching_variant_count = 3;
| Parameter | |
|---|---|
| Name | Description |
value | intThe matchingVariantCount to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | This builder for chaining. |
setPersonalLabels(int index, String value)
public SearchResponse.SearchResult.Builder setPersonalLabels(int index, String value)Specifies previous events related to this product for this user based on UserEvent with same SearchRequest.visitor_id or UserInfo.user_id.
This is set only when SearchRequest.PersonalizationSpec.mode is SearchRequest.PersonalizationSpec.Mode.AUTO.
Possible values:
purchased: Indicates that this product has been purchased before.
repeated string personal_labels = 7;
| Parameters | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | StringThe personalLabels to set. |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | This builder for chaining. |
setProduct(Product value)
public SearchResponse.SearchResult.Builder setProduct(Product value)The product data snippet in the search response. Only Product.name is guaranteed to be populated.
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 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.v2.Product product = 2;
| Parameter | |
|---|---|
| Name | Description |
value | Product |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
setProduct(Product.Builder builderForValue)
public SearchResponse.SearchResult.Builder setProduct(Product.Builder builderForValue)The product data snippet in the search response. Only Product.name is guaranteed to be populated.
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 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.v2.Product product = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Product.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchResponse.SearchResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchResponse.SearchResult.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
SearchResponse.SearchResult.Builder | |