Class SearchResponse.SearchResult.Builder (2.17.0)

public static final class SearchResponse.SearchResult.Builder extends GeneratedMessageV3.Builder<SearchResponse.SearchResult.Builder> implements SearchResponse.SearchResultOrBuilder

Represents the search results.

Protobuf type google.cloud.retail.v2beta.SearchResponse.SearchResult

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<String>

The personalLabels to add.

Returns
TypeDescription
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
NameDescription
valueString

The personalLabels to add.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes of the personalLabels to add.

Returns
TypeDescription
SearchResponse.SearchResult.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchResponse.SearchResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchResponse.SearchResult.Builder
Overrides

build()

public SearchResponse.SearchResult build()
Returns
TypeDescription
SearchResponse.SearchResult

buildPartial()

public SearchResponse.SearchResult buildPartial()
Returns
TypeDescription
SearchResponse.SearchResult

clear()

public SearchResponse.SearchResult.Builder clear()
Returns
TypeDescription
SearchResponse.SearchResult.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SearchResponse.SearchResult.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SearchResponse.SearchResult.Builder
Overrides

clearId()

public SearchResponse.SearchResult.Builder clearId()

Product.id of the searched Product.

string id = 1;

Returns
TypeDescription
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
TypeDescription
SearchResponse.SearchResult.Builder

This builder for chaining.

clearMatchingVariantFields()

public SearchResponse.SearchResult.Builder clearMatchingVariantFields()
Returns
TypeDescription
SearchResponse.SearchResult.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchResponse.SearchResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SearchResponse.SearchResult.Builder
Overrides

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
TypeDescription
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.v2beta.Product product = 2;

Returns
TypeDescription
SearchResponse.SearchResult.Builder

clearVariantRollupValues()

public SearchResponse.SearchResult.Builder clearVariantRollupValues()
Returns
TypeDescription
SearchResponse.SearchResult.Builder

clone()

public SearchResponse.SearchResult.Builder clone()
Returns
TypeDescription
SearchResponse.SearchResult.Builder
Overrides

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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

getDefaultInstanceForType()

public SearchResponse.SearchResult getDefaultInstanceForType()
Returns
TypeDescription
SearchResponse.SearchResult

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getId()

public String getId()

Product.id of the searched Product.

string id = 1;

Returns
TypeDescription
String

The id.

getIdBytes()

public ByteString getIdBytes()

Product.id of the searched Product.

string id = 1;

Returns
TypeDescription
ByteString

The bytes for id.

getMatchingVariantCount()

public int getMatchingVariantCount()

The count of matched variant Products.

int32 matching_variant_count = 3;

Returns
TypeDescription
int

The matchingVariantCount.

getMatchingVariantFields()

public Map<String,FieldMask> getMatchingVariantFields()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueFieldMask
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
FieldMask

getMutableMatchingVariantFields()

public Map<String,FieldMask> getMutableMatchingVariantFields()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,FieldMask>

getMutableVariantRollupValues()

public Map<String,Value> getMutableVariantRollupValues()

Use alternate mutation accessors instead.

Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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.v2beta.Product product = 2;

Returns
TypeDescription
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.v2beta.Product product = 2;

Returns
TypeDescription
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.v2beta.Product product = 2;

Returns
TypeDescription
ProductOrBuilder

getVariantRollupValues()

public Map<String,Value> getVariantRollupValues()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueValue
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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.v2beta.Product product = 2;

Returns
TypeDescription
boolean

Whether the product field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SearchResponse.SearchResult other)

public SearchResponse.SearchResult.Builder mergeFrom(SearchResponse.SearchResult other)
Parameter
NameDescription
otherSearchResponse.SearchResult
Returns
TypeDescription
SearchResponse.SearchResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchResponse.SearchResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse.SearchResult.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SearchResponse.SearchResult.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SearchResponse.SearchResult.Builder
Overrides

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.v2beta.Product product = 2;

Parameter
NameDescription
valueProduct
Returns
TypeDescription
SearchResponse.SearchResult.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.SearchResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchResponse.SearchResult.Builder
Overrides

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
NameDescription
valuesMap<String,FieldMask>
Returns
TypeDescription
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
NameDescription
valuesMap<String,Value>
Returns
TypeDescription
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
NameDescription
keyString
valueFieldMask
Returns
TypeDescription
SearchResponse.SearchResult.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
NameDescription
keyString
valueValue
Returns
TypeDescription
SearchResponse.SearchResult.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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
SearchResponse.SearchResult.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public SearchResponse.SearchResult.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchResponse.SearchResult.Builder
Overrides

setId(String value)

public SearchResponse.SearchResult.Builder setId(String value)

Product.id of the searched Product.

string id = 1;

Parameter
NameDescription
valueString

The id to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for id to set.

Returns
TypeDescription
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
NameDescription
valueint

The matchingVariantCount to set.

Returns
TypeDescription
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
NameDescription
indexint

The index to set the value at.

valueString

The personalLabels to set.

Returns
TypeDescription
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.v2beta.Product product = 2;

Parameter
NameDescription
valueProduct
Returns
TypeDescription
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.v2beta.Product product = 2;

Parameter
NameDescription
builderForValueProduct.Builder
Returns
TypeDescription
SearchResponse.SearchResult.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchResponse.SearchResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SearchResponse.SearchResult.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.SearchResult.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchResponse.SearchResult.Builder
Overrides