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.v2alpha.SearchResponse.SearchResult
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchResponse.SearchResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public SearchResponse.SearchResult build()
Returns
buildPartial()
public SearchResponse.SearchResult buildPartial()
Returns
clear()
public SearchResponse.SearchResult.Builder clear()
Returns
Overrides
clearField(Descriptors.FieldDescriptor field)
public SearchResponse.SearchResult.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearId()
public SearchResponse.SearchResult.Builder clearId()
Product.id of the searched
Product.
string id = 1;
clearMatchingVariantCount()
public SearchResponse.SearchResult.Builder clearMatchingVariantCount()
The count of matched
variant
Products.
int32 matching_variant_count = 3;
clearMatchingVariantFields()
public SearchResponse.SearchResult.Builder clearMatchingVariantFields()
Returns
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchResponse.SearchResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
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.v2alpha.Product product = 2;
clearVariantRollupValues()
public SearchResponse.SearchResult.Builder clearVariantRollupValues()
Returns
clone()
public SearchResponse.SearchResult.Builder clone()
Returns
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;
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;
getDefaultInstanceForType()
public SearchResponse.SearchResult getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getId()
Product.id of the searched
Product.
string id = 1;
getIdBytes()
public ByteString getIdBytes()
Product.id of the searched
Product.
string id = 1;
getMatchingVariantCount()
public int getMatchingVariantCount()
The count of matched
variant
Products.
int32 matching_variant_count = 3;
| Type | Description |
| int | The matchingVariantCount.
|
getMatchingVariantFields()
public Map<String,FieldMask> getMatchingVariantFields()
Returns
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;
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;
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;
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;
getMutableMatchingVariantFields()
public Map<String,FieldMask> getMutableMatchingVariantFields()
Use alternate mutation accessors instead.
getMutableVariantRollupValues()
public Map<String,Value> getMutableVariantRollupValues()
Use alternate mutation accessors instead.
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.v2alpha.Product product = 2;
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.v2alpha.Product product = 2;
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.v2alpha.Product product = 2;
getVariantRollupValues()
public Map<String,Value> getVariantRollupValues()
Returns
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;
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;
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;
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;
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.v2alpha.Product product = 2;
| Type | Description |
| boolean | Whether the product field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(SearchResponse.SearchResult other)
public SearchResponse.SearchResult.Builder mergeFrom(SearchResponse.SearchResult other)
Parameter
Returns
public SearchResponse.SearchResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public SearchResponse.SearchResult.Builder mergeFrom(Message other)
Parameter
Returns
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.v2alpha.Product product = 2;
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchResponse.SearchResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
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;
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;
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;
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;
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;
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;
setField(Descriptors.FieldDescriptor field, Object value)
public SearchResponse.SearchResult.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setId(String value)
public SearchResponse.SearchResult.Builder setId(String value)
Product.id of the searched
Product.
string id = 1;
| Name | Description |
| value | String
The id to set.
|
Returns
setIdBytes(ByteString value)
public SearchResponse.SearchResult.Builder setIdBytes(ByteString value)
Product.id of the searched
Product.
string id = 1;
| Name | Description |
| value | ByteString
The bytes for id to set.
|
Returns
setMatchingVariantCount(int value)
public SearchResponse.SearchResult.Builder setMatchingVariantCount(int value)
The count of matched
variant
Products.
int32 matching_variant_count = 3;
| Name | Description |
| value | int
The matchingVariantCount to set.
|
Returns
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.v2alpha.Product product = 2;
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.v2alpha.Product product = 2;
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchResponse.SearchResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchResponse.SearchResult.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
