public static final class SearchResponse.SearchResult extends GeneratedMessageV3 implements SearchResponse.SearchResultOrBuilder
Represents the search results.
Protobuf type google.cloud.retail.v2alpha.SearchResponse.SearchResult
Static Fields
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MATCHING_VARIANT_COUNT_FIELD_NUMBER
public static final int MATCHING_VARIANT_COUNT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MATCHING_VARIANT_FIELDS_FIELD_NUMBER
public static final int MATCHING_VARIANT_FIELDS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PERSONAL_LABELS_FIELD_NUMBER
public static final int PERSONAL_LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PRODUCT_FIELD_NUMBER
public static final int PRODUCT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
VARIANT_ROLLUP_VALUES_FIELD_NUMBER
public static final int VARIANT_ROLLUP_VALUES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static SearchResponse.SearchResult getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SearchResponse.SearchResult.Builder newBuilder()
newBuilder(SearchResponse.SearchResult prototype)
public static SearchResponse.SearchResult.Builder newBuilder(SearchResponse.SearchResult prototype)
public static SearchResponse.SearchResult parseDelimitedFrom(InputStream input)
public static SearchResponse.SearchResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SearchResponse.SearchResult parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchResponse.SearchResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SearchResponse.SearchResult parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchResponse.SearchResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchResponse.SearchResult parseFrom(CodedInputStream input)
public static SearchResponse.SearchResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchResponse.SearchResult parseFrom(InputStream input)
public static SearchResponse.SearchResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SearchResponse.SearchResult parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchResponse.SearchResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SearchResponse.SearchResult> parser()
Methods
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
|
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public SearchResponse.SearchResult getDefaultInstanceForType()
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;
getMatchingVariantCount()
public int getMatchingVariantCount()
The count of matched
variant
Products.
int32 matching_variant_count = 3;
| Returns |
|---|
| Type | Description |
int | The matchingVariantCount.
|
getMatchingVariantFields()
public Map<String,FieldMask> getMatchingVariantFields()
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;
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;
| Parameter |
|---|
| Name | Description |
key | String
|
getParserForType()
public Parser<SearchResponse.SearchResult> getParserForType()
Overrides
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 | int
The 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 | int
The 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;
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;
| Returns |
|---|
| Type | Description |
Product | The product.
|
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;
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getVariantRollupValues()
public Map<String,Value> getVariantRollupValues()
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;
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;
| 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.v2alpha.Product product = 2;
| Returns |
|---|
| Type | Description |
boolean | Whether the product field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SearchResponse.SearchResult.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchResponse.SearchResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public SearchResponse.SearchResult.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
