com.google.cloud.retail.v2beta

Class SearchResponse.SearchResult

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.retail.v2beta.SearchResponse.SearchResult

All Implemented Interfaces:

SearchResponse.SearchResultOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

SearchResponse

public static final class SearchResponse.SearchResult
extends com.google.protobuf.GeneratedMessageV3
implements SearchResponse.SearchResultOrBuilder

 Represents the search results.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchResponse.SearchResult.Builder Represents the search results.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ID_FIELD_NUMBER
static int	MATCHING_VARIANT_COUNT_FIELD_NUMBER
static int	MATCHING_VARIANT_FIELDS_FIELD_NUMBER
static int	PERSONAL_LABELS_FIELD_NUMBER
static int	PRODUCT_FIELD_NUMBER
static int	VARIANT_ROLLUP_VALUES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsMatchingVariantFields(String key) If a [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product] matches the search query, this map indicates which [Product][google.cloud.retail.v2beta.Product] fields are matched.
boolean	containsVariantRollupValues(String key) The rollup matching [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product] attributes.
boolean	equals(Object obj)
static SearchResponse.SearchResult	getDefaultInstance()
SearchResponse.SearchResult	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getId() [Product.id][google.cloud.retail.v2beta.Product.id] of the searched [Product][google.cloud.retail.v2beta.Product].
com.google.protobuf.ByteString	getIdBytes() [Product.id][google.cloud.retail.v2beta.Product.id] of the searched [Product][google.cloud.retail.v2beta.Product].
int	getMatchingVariantCount() The count of matched [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product]s.
Map<String,com.google.protobuf.FieldMask>	getMatchingVariantFields() Deprecated.
int	getMatchingVariantFieldsCount() If a [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product] matches the search query, this map indicates which [Product][google.cloud.retail.v2beta.Product] fields are matched.
Map<String,com.google.protobuf.FieldMask>	getMatchingVariantFieldsMap() If a [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product] matches the search query, this map indicates which [Product][google.cloud.retail.v2beta.Product] fields are matched.
com.google.protobuf.FieldMask	getMatchingVariantFieldsOrDefault(String key, com.google.protobuf.FieldMask defaultValue) If a [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product] matches the search query, this map indicates which [Product][google.cloud.retail.v2beta.Product] fields are matched.
com.google.protobuf.FieldMask	getMatchingVariantFieldsOrThrow(String key) If a [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product] matches the search query, this map indicates which [Product][google.cloud.retail.v2beta.Product] fields are matched.
com.google.protobuf.Parser<SearchResponse.SearchResult>	getParserForType()
String	getPersonalLabels(int index) Specifies previous events related to this product for this user based on [UserEvent][google.cloud.retail.v2beta.UserEvent] with same [SearchRequest.visitor_id][google.cloud.retail.v2beta.SearchRequest.visitor_id] or [UserInfo.user_id][google.cloud.retail.v2beta.UserInfo.user_id].
com.google.protobuf.ByteString	getPersonalLabelsBytes(int index) Specifies previous events related to this product for this user based on [UserEvent][google.cloud.retail.v2beta.UserEvent] with same [SearchRequest.visitor_id][google.cloud.retail.v2beta.SearchRequest.visitor_id] or [UserInfo.user_id][google.cloud.retail.v2beta.UserInfo.user_id].
int	getPersonalLabelsCount() Specifies previous events related to this product for this user based on [UserEvent][google.cloud.retail.v2beta.UserEvent] with same [SearchRequest.visitor_id][google.cloud.retail.v2beta.SearchRequest.visitor_id] or [UserInfo.user_id][google.cloud.retail.v2beta.UserInfo.user_id].
com.google.protobuf.ProtocolStringList	getPersonalLabelsList() Specifies previous events related to this product for this user based on [UserEvent][google.cloud.retail.v2beta.UserEvent] with same [SearchRequest.visitor_id][google.cloud.retail.v2beta.SearchRequest.visitor_id] or [UserInfo.user_id][google.cloud.retail.v2beta.UserInfo.user_id].
Product	getProduct() The product data snippet in the search response.
ProductOrBuilder	getProductOrBuilder() The product data snippet in the search response.
int	getSerializedSize()
Map<String,com.google.protobuf.Value>	getVariantRollupValues() Deprecated.
int	getVariantRollupValuesCount() The rollup matching [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product] attributes.
Map<String,com.google.protobuf.Value>	getVariantRollupValuesMap() The rollup matching [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product] attributes.
com.google.protobuf.Value	getVariantRollupValuesOrDefault(String key, com.google.protobuf.Value defaultValue) The rollup matching [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product] attributes.
com.google.protobuf.Value	getVariantRollupValuesOrThrow(String key) The rollup matching [variant][google.cloud.retail.v2beta.Product.Type.VARIANT] [Product][google.cloud.retail.v2beta.Product] attributes.
int	hashCode()
boolean	hasProduct() The product data snippet in the search response.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static SearchResponse.SearchResult.Builder	newBuilder()
static SearchResponse.SearchResult.Builder	newBuilder(SearchResponse.SearchResult prototype)
SearchResponse.SearchResult.Builder	newBuilderForType()
protected SearchResponse.SearchResult.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SearchResponse.SearchResult	parseDelimitedFrom(InputStream input)
static SearchResponse.SearchResult	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.SearchResult	parseFrom(byte[] data)
static SearchResponse.SearchResult	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.SearchResult	parseFrom(ByteBuffer data)
static SearchResponse.SearchResult	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.SearchResult	parseFrom(com.google.protobuf.ByteString data)
static SearchResponse.SearchResult	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.SearchResult	parseFrom(com.google.protobuf.CodedInputStream input)
static SearchResponse.SearchResult	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.SearchResult	parseFrom(InputStream input)
static SearchResponse.SearchResult	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchResponse.SearchResult>	parser()
SearchResponse.SearchResult.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

See Also:

Constant Field Values

PRODUCT_FIELD_NUMBER

public static final int PRODUCT_FIELD_NUMBER

See Also:

Constant Field Values

MATCHING_VARIANT_COUNT_FIELD_NUMBER

public static final int MATCHING_VARIANT_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

MATCHING_VARIANT_FIELDS_FIELD_NUMBER

public static final int MATCHING_VARIANT_FIELDS_FIELD_NUMBER

See Also:

Constant Field Values

VARIANT_ROLLUP_VALUES_FIELD_NUMBER

public static final int VARIANT_ROLLUP_VALUES_FIELD_NUMBER

See Also:

Constant Field Values

PERSONAL_LABELS_FIELD_NUMBER

public static final int PERSONAL_LABELS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getId

public String getId()

 [Product.id][google.cloud.retail.v2beta.Product.id] of the searched
 [Product][google.cloud.retail.v2beta.Product].
 

string id = 1;

Specified by:

getId in interface SearchResponse.SearchResultOrBuilder

Returns:

The id.

getIdBytes

public com.google.protobuf.ByteString getIdBytes()

 [Product.id][google.cloud.retail.v2beta.Product.id] of the searched
 [Product][google.cloud.retail.v2beta.Product].
 

string id = 1;

Specified by:

getIdBytes in interface SearchResponse.SearchResultOrBuilder

Returns:

The bytes for id.

hasProduct

public boolean hasProduct()

 The product data snippet in the search response. Only
 [Product.name][google.cloud.retail.v2beta.Product.name] is guaranteed to
 be populated.

 [Product.variants][google.cloud.retail.v2beta.Product.variants] contains
 the product variants that match the search query. If there are multiple
 product variants matching the query, top 5 most relevant product variants
 are returned and ordered by relevancy.

 If relevancy can be deternmined, use
 [matching_variant_fields][google.cloud.retail.v2beta.SearchResponse.SearchResult.matching_variant_fields]
 to look up matched product variants fields. If relevancy cannot be
 determined, e.g. when searching "shoe" all products in a shoe product can
 be a match, 5 product variants are returned but order is meaningless.
 

.google.cloud.retail.v2beta.Product product = 2;

Specified by:

hasProduct in interface SearchResponse.SearchResultOrBuilder

Returns:

Whether the product field is set.

getProduct

public Product getProduct()

 The product data snippet in the search response. Only
 [Product.name][google.cloud.retail.v2beta.Product.name] is guaranteed to
 be populated.

 [Product.variants][google.cloud.retail.v2beta.Product.variants] contains
 the product variants that match the search query. If there are multiple
 product variants matching the query, top 5 most relevant product variants
 are returned and ordered by relevancy.

 If relevancy can be deternmined, use
 [matching_variant_fields][google.cloud.retail.v2beta.SearchResponse.SearchResult.matching_variant_fields]
 to look up matched product variants fields. If relevancy cannot be
 determined, e.g. when searching "shoe" all products in a shoe product can
 be a match, 5 product variants are returned but order is meaningless.
 

.google.cloud.retail.v2beta.Product product = 2;

Specified by:

getProduct in interface SearchResponse.SearchResultOrBuilder

Returns:

The product.

getProductOrBuilder

public ProductOrBuilder getProductOrBuilder()

 The product data snippet in the search response. Only
 [Product.name][google.cloud.retail.v2beta.Product.name] is guaranteed to
 be populated.

 [Product.variants][google.cloud.retail.v2beta.Product.variants] contains
 the product variants that match the search query. If there are multiple
 product variants matching the query, top 5 most relevant product variants
 are returned and ordered by relevancy.

 If relevancy can be deternmined, use
 [matching_variant_fields][google.cloud.retail.v2beta.SearchResponse.SearchResult.matching_variant_fields]
 to look up matched product variants fields. If relevancy cannot be
 determined, e.g. when searching "shoe" all products in a shoe product can
 be a match, 5 product variants are returned but order is meaningless.
 

.google.cloud.retail.v2beta.Product product = 2;

Specified by:

getProductOrBuilder in interface SearchResponse.SearchResultOrBuilder

getMatchingVariantCount

public int getMatchingVariantCount()

 The count of matched
 [variant][google.cloud.retail.v2beta.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2beta.Product]s.
 

int32 matching_variant_count = 3;

Specified by:

getMatchingVariantCount in interface SearchResponse.SearchResultOrBuilder

Returns:

The matchingVariantCount.

getMatchingVariantFieldsCount

public int getMatchingVariantFieldsCount()

Description copied from interface: SearchResponse.SearchResultOrBuilder

 If a [variant][google.cloud.retail.v2beta.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2beta.Product] matches the search query,
 this map indicates which [Product][google.cloud.retail.v2beta.Product]
 fields are matched. The key is the
 [Product.name][google.cloud.retail.v2beta.Product.name], the value is a
 field mask of the matched [Product][google.cloud.retail.v2beta.Product]
 fields. If matched attributes cannot be determined, this map will be
 empty.

 For example, a key "sku1" with field mask
 "products.color_info" indicates there is a match between
 "sku1" [ColorInfo][google.cloud.retail.v2beta.ColorInfo] and the query.
 

map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;

Specified by:

getMatchingVariantFieldsCount in interface SearchResponse.SearchResultOrBuilder

containsMatchingVariantFields

public boolean containsMatchingVariantFields(String key)

 If a [variant][google.cloud.retail.v2beta.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2beta.Product] matches the search query,
 this map indicates which [Product][google.cloud.retail.v2beta.Product]
 fields are matched. The key is the
 [Product.name][google.cloud.retail.v2beta.Product.name], the value is a
 field mask of the matched [Product][google.cloud.retail.v2beta.Product]
 fields. If matched attributes cannot be determined, this map will be
 empty.

 For example, a key "sku1" with field mask
 "products.color_info" indicates there is a match between
 "sku1" [ColorInfo][google.cloud.retail.v2beta.ColorInfo] and the query.
 

map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;

Specified by:

containsMatchingVariantFields in interface SearchResponse.SearchResultOrBuilder

getMatchingVariantFields

@Deprecated
public Map<String,com.google.protobuf.FieldMask> getMatchingVariantFields()

Deprecated.

Use getMatchingVariantFieldsMap() instead.

Specified by:

getMatchingVariantFields in interface SearchResponse.SearchResultOrBuilder

getMatchingVariantFieldsMap

public Map<String,com.google.protobuf.FieldMask> getMatchingVariantFieldsMap()

 If a [variant][google.cloud.retail.v2beta.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2beta.Product] matches the search query,
 this map indicates which [Product][google.cloud.retail.v2beta.Product]
 fields are matched. The key is the
 [Product.name][google.cloud.retail.v2beta.Product.name], the value is a
 field mask of the matched [Product][google.cloud.retail.v2beta.Product]
 fields. If matched attributes cannot be determined, this map will be
 empty.

 For example, a key "sku1" with field mask
 "products.color_info" indicates there is a match between
 "sku1" [ColorInfo][google.cloud.retail.v2beta.ColorInfo] and the query.
 

map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;

Specified by:

getMatchingVariantFieldsMap in interface SearchResponse.SearchResultOrBuilder

getMatchingVariantFieldsOrDefault

public com.google.protobuf.FieldMask getMatchingVariantFieldsOrDefault(String key,
                                                                       com.google.protobuf.FieldMask defaultValue)

 If a [variant][google.cloud.retail.v2beta.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2beta.Product] matches the search query,
 this map indicates which [Product][google.cloud.retail.v2beta.Product]
 fields are matched. The key is the
 [Product.name][google.cloud.retail.v2beta.Product.name], the value is a
 field mask of the matched [Product][google.cloud.retail.v2beta.Product]
 fields. If matched attributes cannot be determined, this map will be
 empty.

 For example, a key "sku1" with field mask
 "products.color_info" indicates there is a match between
 "sku1" [ColorInfo][google.cloud.retail.v2beta.ColorInfo] and the query.
 

map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;

Specified by:

getMatchingVariantFieldsOrDefault in interface SearchResponse.SearchResultOrBuilder

getMatchingVariantFieldsOrThrow

public com.google.protobuf.FieldMask getMatchingVariantFieldsOrThrow(String key)

 If a [variant][google.cloud.retail.v2beta.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2beta.Product] matches the search query,
 this map indicates which [Product][google.cloud.retail.v2beta.Product]
 fields are matched. The key is the
 [Product.name][google.cloud.retail.v2beta.Product.name], the value is a
 field mask of the matched [Product][google.cloud.retail.v2beta.Product]
 fields. If matched attributes cannot be determined, this map will be
 empty.

 For example, a key "sku1" with field mask
 "products.color_info" indicates there is a match between
 "sku1" [ColorInfo][google.cloud.retail.v2beta.ColorInfo] and the query.
 

map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;

Specified by:

getMatchingVariantFieldsOrThrow in interface SearchResponse.SearchResultOrBuilder

getVariantRollupValuesCount

public int getVariantRollupValuesCount()

Description copied from interface: SearchResponse.SearchResultOrBuilder

 The rollup matching
 [variant][google.cloud.retail.v2beta.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2beta.Product] attributes. The key is one
 of the
 [SearchRequest.variant_rollup_keys][google.cloud.retail.v2beta.SearchRequest.variant_rollup_keys].
 The values are the merged and de-duplicated
 [Product][google.cloud.retail.v2beta.Product] attributes. Notice that the
 rollup values are respect filter. For example, when filtering by
 "colorFamilies:ANY(\"red\")" and rollup "colorFamilies", only "red" is
 returned.

 For textual and numerical attributes, the rollup values is a list of
 string or double values with type
 [google.protobuf.ListValue][google.protobuf.ListValue]. For example, if
 there are two variants with colors "red" and "blue", the rollup values
 are

     { key: "colorFamilies"
       value {
         list_value {
           values { string_value: "red" }
           values { string_value: "blue" }
          }
       }
     }

 For [FulfillmentInfo][google.cloud.retail.v2beta.FulfillmentInfo], the
 rollup values is a double value with type
 [google.protobuf.Value][google.protobuf.Value]. For example,
 `{key: "pickupInStore.store1" value { number_value: 10 }}` means a there
 are 10 variants in this product are available in the store "store1".
 

map<string, .google.protobuf.Value> variant_rollup_values = 5;

Specified by:

getVariantRollupValuesCount in interface SearchResponse.SearchResultOrBuilder

containsVariantRollupValues

public boolean containsVariantRollupValues(String key)

 The rollup matching
 [variant][google.cloud.retail.v2beta.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2beta.Product] attributes. The key is one
 of the
 [SearchRequest.variant_rollup_keys][google.cloud.retail.v2beta.SearchRequest.variant_rollup_keys].
 The values are the merged and de-duplicated
 [Product][google.cloud.retail.v2beta.Product] attributes. Notice that the
 rollup values are respect filter. For example, when filtering by
 "colorFamilies:ANY(\"red\")" and rollup "colorFamilies", only "red" is
 returned.

 For textual and numerical attributes, the rollup values is a list of
 string or double values with type
 [google.protobuf.ListValue][google.protobuf.ListValue]. For example, if
 there are two variants with colors "red" and "blue", the rollup values
 are

     { key: "colorFamilies"
       value {
         list_value {
           values { string_value: "red" }
           values { string_value: "blue" }
          }
       }
     }

 For [FulfillmentInfo][google.cloud.retail.v2beta.FulfillmentInfo], the
 rollup values is a double value with type
 [google.protobuf.Value][google.protobuf.Value]. For example,
 `{key: "pickupInStore.store1" value { number_value: 10 }}` means a there
 are 10 variants in this product are available in the store "store1".
 

map<string, .google.protobuf.Value> variant_rollup_values = 5;

Specified by:

containsVariantRollupValues in interface SearchResponse.SearchResultOrBuilder

getVariantRollupValues

@Deprecated
public Map<String,com.google.protobuf.Value> getVariantRollupValues()

Deprecated.

Use getVariantRollupValuesMap() instead.

Specified by:

getVariantRollupValues in interface SearchResponse.SearchResultOrBuilder

getVariantRollupValuesMap

public Map<String,com.google.protobuf.Value> getVariantRollupValuesMap()

 The rollup matching
 [variant][google.cloud.retail.v2beta.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2beta.Product] attributes. The key is one
 of the
 [SearchRequest.variant_rollup_keys][google.cloud.retail.v2beta.SearchRequest.variant_rollup_keys].
 The values are the merged and de-duplicated
 [Product][google.cloud.retail.v2beta.Product] attributes. Notice that the
 rollup values are respect filter. For example, when filtering by
 "colorFamilies:ANY(\"red\")" and rollup "colorFamilies", only "red" is
 returned.

 For textual and numerical attributes, the rollup values is a list of
 string or double values with type
 [google.protobuf.ListValue][google.protobuf.ListValue]. For example, if
 there are two variants with colors "red" and "blue", the rollup values
 are

     { key: "colorFamilies"
       value {
         list_value {
           values { string_value: "red" }
           values { string_value: "blue" }
          }
       }
     }

 For [FulfillmentInfo][google.cloud.retail.v2beta.FulfillmentInfo], the
 rollup values is a double value with type
 [google.protobuf.Value][google.protobuf.Value]. For example,
 `{key: "pickupInStore.store1" value { number_value: 10 }}` means a there
 are 10 variants in this product are available in the store "store1".
 

map<string, .google.protobuf.Value> variant_rollup_values = 5;

Specified by:

getVariantRollupValuesMap in interface SearchResponse.SearchResultOrBuilder

getVariantRollupValuesOrDefault

public com.google.protobuf.Value getVariantRollupValuesOrDefault(String key,
                                                                 com.google.protobuf.Value defaultValue)

 The rollup matching
 [variant][google.cloud.retail.v2beta.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2beta.Product] attributes. The key is one
 of the
 [SearchRequest.variant_rollup_keys][google.cloud.retail.v2beta.SearchRequest.variant_rollup_keys].
 The values are the merged and de-duplicated
 [Product][google.cloud.retail.v2beta.Product] attributes. Notice that the
 rollup values are respect filter. For example, when filtering by
 "colorFamilies:ANY(\"red\")" and rollup "colorFamilies", only "red" is
 returned.

 For textual and numerical attributes, the rollup values is a list of
 string or double values with type
 [google.protobuf.ListValue][google.protobuf.ListValue]. For example, if
 there are two variants with colors "red" and "blue", the rollup values
 are

     { key: "colorFamilies"
       value {
         list_value {
           values { string_value: "red" }
           values { string_value: "blue" }
          }
       }
     }

 For [FulfillmentInfo][google.cloud.retail.v2beta.FulfillmentInfo], the
 rollup values is a double value with type
 [google.protobuf.Value][google.protobuf.Value]. For example,
 `{key: "pickupInStore.store1" value { number_value: 10 }}` means a there
 are 10 variants in this product are available in the store "store1".
 

map<string, .google.protobuf.Value> variant_rollup_values = 5;

Specified by:

getVariantRollupValuesOrDefault in interface SearchResponse.SearchResultOrBuilder

getVariantRollupValuesOrThrow

public com.google.protobuf.Value getVariantRollupValuesOrThrow(String key)

 The rollup matching
 [variant][google.cloud.retail.v2beta.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2beta.Product] attributes. The key is one
 of the
 [SearchRequest.variant_rollup_keys][google.cloud.retail.v2beta.SearchRequest.variant_rollup_keys].
 The values are the merged and de-duplicated
 [Product][google.cloud.retail.v2beta.Product] attributes. Notice that the
 rollup values are respect filter. For example, when filtering by
 "colorFamilies:ANY(\"red\")" and rollup "colorFamilies", only "red" is
 returned.

 For textual and numerical attributes, the rollup values is a list of
 string or double values with type
 [google.protobuf.ListValue][google.protobuf.ListValue]. For example, if
 there are two variants with colors "red" and "blue", the rollup values
 are

     { key: "colorFamilies"
       value {
         list_value {
           values { string_value: "red" }
           values { string_value: "blue" }
          }
       }
     }

 For [FulfillmentInfo][google.cloud.retail.v2beta.FulfillmentInfo], the
 rollup values is a double value with type
 [google.protobuf.Value][google.protobuf.Value]. For example,
 `{key: "pickupInStore.store1" value { number_value: 10 }}` means a there
 are 10 variants in this product are available in the store "store1".
 

map<string, .google.protobuf.Value> variant_rollup_values = 5;

Specified by:

getVariantRollupValuesOrThrow in interface SearchResponse.SearchResultOrBuilder

getPersonalLabelsList

public com.google.protobuf.ProtocolStringList getPersonalLabelsList()

 Specifies previous events related to this product for this user based on
 [UserEvent][google.cloud.retail.v2beta.UserEvent] with same
 [SearchRequest.visitor_id][google.cloud.retail.v2beta.SearchRequest.visitor_id]
 or [UserInfo.user_id][google.cloud.retail.v2beta.UserInfo.user_id].

 This is set only when
 [SearchRequest.PersonalizationSpec.mode][google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec.mode]
 is
 [SearchRequest.PersonalizationSpec.Mode.AUTO][google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec.Mode.AUTO].

 Possible values:

 * `purchased`: Indicates that this product has been purchased before.
 

repeated string personal_labels = 7;

Specified by:

getPersonalLabelsList in interface SearchResponse.SearchResultOrBuilder

Returns:

A list containing the personalLabels.

getPersonalLabelsCount

public int getPersonalLabelsCount()

 Specifies previous events related to this product for this user based on
 [UserEvent][google.cloud.retail.v2beta.UserEvent] with same
 [SearchRequest.visitor_id][google.cloud.retail.v2beta.SearchRequest.visitor_id]
 or [UserInfo.user_id][google.cloud.retail.v2beta.UserInfo.user_id].

 This is set only when
 [SearchRequest.PersonalizationSpec.mode][google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec.mode]
 is
 [SearchRequest.PersonalizationSpec.Mode.AUTO][google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec.Mode.AUTO].

 Possible values:

 * `purchased`: Indicates that this product has been purchased before.
 

repeated string personal_labels = 7;

Specified by:

getPersonalLabelsCount in interface SearchResponse.SearchResultOrBuilder

Returns:

The count of personalLabels.

getPersonalLabels

public String getPersonalLabels(int index)

 Specifies previous events related to this product for this user based on
 [UserEvent][google.cloud.retail.v2beta.UserEvent] with same
 [SearchRequest.visitor_id][google.cloud.retail.v2beta.SearchRequest.visitor_id]
 or [UserInfo.user_id][google.cloud.retail.v2beta.UserInfo.user_id].

 This is set only when
 [SearchRequest.PersonalizationSpec.mode][google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec.mode]
 is
 [SearchRequest.PersonalizationSpec.Mode.AUTO][google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec.Mode.AUTO].

 Possible values:

 * `purchased`: Indicates that this product has been purchased before.
 

repeated string personal_labels = 7;

Specified by:

getPersonalLabels in interface SearchResponse.SearchResultOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The personalLabels at the given index.

getPersonalLabelsBytes

public com.google.protobuf.ByteString getPersonalLabelsBytes(int index)

 Specifies previous events related to this product for this user based on
 [UserEvent][google.cloud.retail.v2beta.UserEvent] with same
 [SearchRequest.visitor_id][google.cloud.retail.v2beta.SearchRequest.visitor_id]
 or [UserInfo.user_id][google.cloud.retail.v2beta.UserInfo.user_id].

 This is set only when
 [SearchRequest.PersonalizationSpec.mode][google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec.mode]
 is
 [SearchRequest.PersonalizationSpec.Mode.AUTO][google.cloud.retail.v2beta.SearchRequest.PersonalizationSpec.Mode.AUTO].

 Possible values:

 * `purchased`: Indicates that this product has been purchased before.
 

repeated string personal_labels = 7;

Specified by:

getPersonalLabelsBytes in interface SearchResponse.SearchResultOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the personalLabels at the given index.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SearchResponse.SearchResult parseFrom(ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.SearchResult parseFrom(ByteBuffer data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.SearchResult parseFrom(com.google.protobuf.ByteString data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.SearchResult parseFrom(com.google.protobuf.ByteString data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.SearchResult parseFrom(byte[] data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.SearchResult parseFrom(byte[] data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.SearchResult parseFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

public static SearchResponse.SearchResult parseFrom(InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchResponse.SearchResult parseDelimitedFrom(InputStream input)
                                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchResponse.SearchResult parseDelimitedFrom(InputStream input,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws IOException

Throws:

IOException

parseFrom

public static SearchResponse.SearchResult parseFrom(com.google.protobuf.CodedInputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

public static SearchResponse.SearchResult parseFrom(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

newBuilderForType

public SearchResponse.SearchResult.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SearchResponse.SearchResult.Builder newBuilder()

newBuilder

public static SearchResponse.SearchResult.Builder newBuilder(SearchResponse.SearchResult prototype)

toBuilder

public SearchResponse.SearchResult.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SearchResponse.SearchResult.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SearchResponse.SearchResult getDefaultInstance()

parser

public static com.google.protobuf.Parser<SearchResponse.SearchResult> parser()

getParserForType

public com.google.protobuf.Parser<SearchResponse.SearchResult> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SearchResponse.SearchResult getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder