Package com.google.cloud.retail.v2

Class SearchResponse.SearchResult.Builder

    • Method Detail

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

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.SearchResult.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.SearchResult.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.SearchResult.Builder>

      • getDefaultInstanceForType

        public SearchResponse.SearchResult getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public SearchResponse.SearchResult build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public SearchResponse.SearchResult buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.SearchResult.Builder>

      • mergeFrom

        public SearchResponse.SearchResult.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchResponse.SearchResult.Builder>
        Throws:
        IOException

      • getId

        public String getId()
         [Product.id][google.cloud.retail.v2.Product.id] of the searched
 [Product][google.cloud.retail.v2.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.v2.Product.id] of the searched
 [Product][google.cloud.retail.v2.Product].
        string id = 1;
        Specified by:
        getIdBytes in interface SearchResponse.SearchResultOrBuilder
        Returns:
        The bytes for id.

      • setId

        public SearchResponse.SearchResult.Builder setId​(String value)
         [Product.id][google.cloud.retail.v2.Product.id] of the searched
 [Product][google.cloud.retail.v2.Product].
        string id = 1;
        Parameters:
        value - The id to set.
        Returns:
        This builder for chaining.

      • clearId

        public SearchResponse.SearchResult.Builder clearId()
         [Product.id][google.cloud.retail.v2.Product.id] of the searched
 [Product][google.cloud.retail.v2.Product].
        string id = 1;
        Returns:
        This builder for chaining.

      • setIdBytes

        public SearchResponse.SearchResult.Builder setIdBytes​(com.google.protobuf.ByteString value)
         [Product.id][google.cloud.retail.v2.Product.id] of the searched
 [Product][google.cloud.retail.v2.Product].
        string id = 1;
        Parameters:
        value - The bytes for id to set.
        Returns:
        This builder for chaining.

      • hasProduct

        public boolean hasProduct()
         The product data snippet in the search response. Only
 [Product.name][google.cloud.retail.v2.Product.name] is guaranteed to be
 populated.

 [Product.variants][google.cloud.retail.v2.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.v2.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.v2.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.v2.Product.name] is guaranteed to be
 populated.

 [Product.variants][google.cloud.retail.v2.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.v2.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.v2.Product product = 2;
        Specified by:
        getProduct in interface SearchResponse.SearchResultOrBuilder
        Returns:
        The product.

      • setProduct

        public SearchResponse.SearchResult.Builder setProduct​(Product value)
         The product data snippet in the search response. Only
 [Product.name][google.cloud.retail.v2.Product.name] is guaranteed to be
 populated.

 [Product.variants][google.cloud.retail.v2.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.v2.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.v2.Product product = 2;

      • setProduct

        public SearchResponse.SearchResult.Builder setProduct​(Product.Builder builderForValue)
         The product data snippet in the search response. Only
 [Product.name][google.cloud.retail.v2.Product.name] is guaranteed to be
 populated.

 [Product.variants][google.cloud.retail.v2.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.v2.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.v2.Product product = 2;

      • mergeProduct

        public SearchResponse.SearchResult.Builder mergeProduct​(Product value)
         The product data snippet in the search response. Only
 [Product.name][google.cloud.retail.v2.Product.name] is guaranteed to be
 populated.

 [Product.variants][google.cloud.retail.v2.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.v2.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.v2.Product product = 2;

      • clearProduct

        public SearchResponse.SearchResult.Builder clearProduct()
         The product data snippet in the search response. Only
 [Product.name][google.cloud.retail.v2.Product.name] is guaranteed to be
 populated.

 [Product.variants][google.cloud.retail.v2.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.v2.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.v2.Product product = 2;

      • getProductBuilder

        public Product.Builder getProductBuilder()
         The product data snippet in the search response. Only
 [Product.name][google.cloud.retail.v2.Product.name] is guaranteed to be
 populated.

 [Product.variants][google.cloud.retail.v2.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.v2.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.v2.Product product = 2;

      • getProductOrBuilder

        public ProductOrBuilder getProductOrBuilder()
         The product data snippet in the search response. Only
 [Product.name][google.cloud.retail.v2.Product.name] is guaranteed to be
 populated.

 [Product.variants][google.cloud.retail.v2.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.v2.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.v2.Product product = 2;
        Specified by:
        getProductOrBuilder in interface SearchResponse.SearchResultOrBuilder

      • getMatchingVariantCount

        public int getMatchingVariantCount()
         The count of matched
 [variant][google.cloud.retail.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product]s.
        int32 matching_variant_count = 3;
        Specified by:
        getMatchingVariantCount in interface SearchResponse.SearchResultOrBuilder
        Returns:
        The matchingVariantCount.

      • setMatchingVariantCount

        public SearchResponse.SearchResult.Builder setMatchingVariantCount​(int value)
         The count of matched
 [variant][google.cloud.retail.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product]s.
        int32 matching_variant_count = 3;
        Parameters:
        value - The matchingVariantCount to set.
        Returns:
        This builder for chaining.

      • clearMatchingVariantCount

        public SearchResponse.SearchResult.Builder clearMatchingVariantCount()
         The count of matched
 [variant][google.cloud.retail.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product]s.
        int32 matching_variant_count = 3;
        Returns:
        This builder for chaining.

      • getMatchingVariantFieldsCount

        public int getMatchingVariantFieldsCount()
        Description copied from interface: SearchResponse.SearchResultOrBuilder
         If a [variant][google.cloud.retail.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product] matches the search query, this
 map indicates which [Product][google.cloud.retail.v2.Product] fields are
 matched. The key is the
 [Product.name][google.cloud.retail.v2.Product.name], the value is a field
 mask of the matched [Product][google.cloud.retail.v2.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.v2.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.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product] matches the search query, this
 map indicates which [Product][google.cloud.retail.v2.Product] fields are
 matched. The key is the
 [Product.name][google.cloud.retail.v2.Product.name], the value is a field
 mask of the matched [Product][google.cloud.retail.v2.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.v2.ColorInfo] and the query.
        map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;
        Specified by:
        containsMatchingVariantFields in interface SearchResponse.SearchResultOrBuilder

      • getMatchingVariantFieldsMap

        public Map<String,​com.google.protobuf.FieldMask> getMatchingVariantFieldsMap()
         If a [variant][google.cloud.retail.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product] matches the search query, this
 map indicates which [Product][google.cloud.retail.v2.Product] fields are
 matched. The key is the
 [Product.name][google.cloud.retail.v2.Product.name], the value is a field
 mask of the matched [Product][google.cloud.retail.v2.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.v2.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.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product] matches the search query, this
 map indicates which [Product][google.cloud.retail.v2.Product] fields are
 matched. The key is the
 [Product.name][google.cloud.retail.v2.Product.name], the value is a field
 mask of the matched [Product][google.cloud.retail.v2.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.v2.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.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product] matches the search query, this
 map indicates which [Product][google.cloud.retail.v2.Product] fields are
 matched. The key is the
 [Product.name][google.cloud.retail.v2.Product.name], the value is a field
 mask of the matched [Product][google.cloud.retail.v2.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.v2.ColorInfo] and the query.
        map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;
        Specified by:
        getMatchingVariantFieldsOrThrow in interface SearchResponse.SearchResultOrBuilder

      • removeMatchingVariantFields

        public SearchResponse.SearchResult.Builder removeMatchingVariantFields​(String key)
         If a [variant][google.cloud.retail.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product] matches the search query, this
 map indicates which [Product][google.cloud.retail.v2.Product] fields are
 matched. The key is the
 [Product.name][google.cloud.retail.v2.Product.name], the value is a field
 mask of the matched [Product][google.cloud.retail.v2.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.v2.ColorInfo] and the query.
        map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;

      • getMutableMatchingVariantFields

        @Deprecated
public Map<String,​com.google.protobuf.FieldMask> getMutableMatchingVariantFields()
        Deprecated.
        Use alternate mutation accessors instead.

      • putMatchingVariantFields

        public SearchResponse.SearchResult.Builder putMatchingVariantFields​(String key,
                                                                    com.google.protobuf.FieldMask value)
         If a [variant][google.cloud.retail.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product] matches the search query, this
 map indicates which [Product][google.cloud.retail.v2.Product] fields are
 matched. The key is the
 [Product.name][google.cloud.retail.v2.Product.name], the value is a field
 mask of the matched [Product][google.cloud.retail.v2.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.v2.ColorInfo] and the query.
        map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;

      • putAllMatchingVariantFields

        public SearchResponse.SearchResult.Builder putAllMatchingVariantFields​(Map<String,​com.google.protobuf.FieldMask> values)
         If a [variant][google.cloud.retail.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product] matches the search query, this
 map indicates which [Product][google.cloud.retail.v2.Product] fields are
 matched. The key is the
 [Product.name][google.cloud.retail.v2.Product.name], the value is a field
 mask of the matched [Product][google.cloud.retail.v2.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.v2.ColorInfo] and the query.
        map<string, .google.protobuf.FieldMask> matching_variant_fields = 4;

      • getVariantRollupValuesCount

        public int getVariantRollupValuesCount()
        Description copied from interface: SearchResponse.SearchResultOrBuilder
         The rollup matching
 [variant][google.cloud.retail.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product] attributes. The key is one of
 the
 [SearchRequest.variant_rollup_keys][google.cloud.retail.v2.SearchRequest.variant_rollup_keys].
 The values are the merged and de-duplicated
 [Product][google.cloud.retail.v2.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.v2.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.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product] attributes. The key is one of
 the
 [SearchRequest.variant_rollup_keys][google.cloud.retail.v2.SearchRequest.variant_rollup_keys].
 The values are the merged and de-duplicated
 [Product][google.cloud.retail.v2.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.v2.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

      • getVariantRollupValuesMap

        public Map<String,​com.google.protobuf.Value> getVariantRollupValuesMap()
         The rollup matching
 [variant][google.cloud.retail.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product] attributes. The key is one of
 the
 [SearchRequest.variant_rollup_keys][google.cloud.retail.v2.SearchRequest.variant_rollup_keys].
 The values are the merged and de-duplicated
 [Product][google.cloud.retail.v2.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.v2.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.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product] attributes. The key is one of
 the
 [SearchRequest.variant_rollup_keys][google.cloud.retail.v2.SearchRequest.variant_rollup_keys].
 The values are the merged and de-duplicated
 [Product][google.cloud.retail.v2.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.v2.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.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product] attributes. The key is one of
 the
 [SearchRequest.variant_rollup_keys][google.cloud.retail.v2.SearchRequest.variant_rollup_keys].
 The values are the merged and de-duplicated
 [Product][google.cloud.retail.v2.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.v2.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

      • removeVariantRollupValues

        public SearchResponse.SearchResult.Builder removeVariantRollupValues​(String key)
         The rollup matching
 [variant][google.cloud.retail.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product] attributes. The key is one of
 the
 [SearchRequest.variant_rollup_keys][google.cloud.retail.v2.SearchRequest.variant_rollup_keys].
 The values are the merged and de-duplicated
 [Product][google.cloud.retail.v2.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.v2.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;

      • getMutableVariantRollupValues

        @Deprecated
public Map<String,​com.google.protobuf.Value> getMutableVariantRollupValues()
        Deprecated.
        Use alternate mutation accessors instead.

      • putVariantRollupValues

        public SearchResponse.SearchResult.Builder putVariantRollupValues​(String key,
                                                                  com.google.protobuf.Value value)
         The rollup matching
 [variant][google.cloud.retail.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product] attributes. The key is one of
 the
 [SearchRequest.variant_rollup_keys][google.cloud.retail.v2.SearchRequest.variant_rollup_keys].
 The values are the merged and de-duplicated
 [Product][google.cloud.retail.v2.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.v2.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;

      • putAllVariantRollupValues

        public SearchResponse.SearchResult.Builder putAllVariantRollupValues​(Map<String,​com.google.protobuf.Value> values)
         The rollup matching
 [variant][google.cloud.retail.v2.Product.Type.VARIANT]
 [Product][google.cloud.retail.v2.Product] attributes. The key is one of
 the
 [SearchRequest.variant_rollup_keys][google.cloud.retail.v2.SearchRequest.variant_rollup_keys].
 The values are the merged and de-duplicated
 [Product][google.cloud.retail.v2.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.v2.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;

      • getPersonalLabelsList

        public com.google.protobuf.ProtocolStringList getPersonalLabelsList()
         Specifies previous events related to this product for this user based on
 [UserEvent][google.cloud.retail.v2.UserEvent] with same
 [SearchRequest.visitor_id][google.cloud.retail.v2.SearchRequest.visitor_id]
 or [UserInfo.user_id][google.cloud.retail.v2.UserInfo.user_id].

 This is set only when
 [SearchRequest.PersonalizationSpec.mode][google.cloud.retail.v2.SearchRequest.PersonalizationSpec.mode]
 is
 [SearchRequest.PersonalizationSpec.Mode.AUTO][google.cloud.retail.v2.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.v2.UserEvent] with same
 [SearchRequest.visitor_id][google.cloud.retail.v2.SearchRequest.visitor_id]
 or [UserInfo.user_id][google.cloud.retail.v2.UserInfo.user_id].

 This is set only when
 [SearchRequest.PersonalizationSpec.mode][google.cloud.retail.v2.SearchRequest.PersonalizationSpec.mode]
 is
 [SearchRequest.PersonalizationSpec.Mode.AUTO][google.cloud.retail.v2.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.v2.UserEvent] with same
 [SearchRequest.visitor_id][google.cloud.retail.v2.SearchRequest.visitor_id]
 or [UserInfo.user_id][google.cloud.retail.v2.UserInfo.user_id].

 This is set only when
 [SearchRequest.PersonalizationSpec.mode][google.cloud.retail.v2.SearchRequest.PersonalizationSpec.mode]
 is
 [SearchRequest.PersonalizationSpec.Mode.AUTO][google.cloud.retail.v2.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.v2.UserEvent] with same
 [SearchRequest.visitor_id][google.cloud.retail.v2.SearchRequest.visitor_id]
 or [UserInfo.user_id][google.cloud.retail.v2.UserInfo.user_id].

 This is set only when
 [SearchRequest.PersonalizationSpec.mode][google.cloud.retail.v2.SearchRequest.PersonalizationSpec.mode]
 is
 [SearchRequest.PersonalizationSpec.Mode.AUTO][google.cloud.retail.v2.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.

      • setPersonalLabels

        public SearchResponse.SearchResult.Builder setPersonalLabels​(int index,
                                                             String value)
         Specifies previous events related to this product for this user based on
 [UserEvent][google.cloud.retail.v2.UserEvent] with same
 [SearchRequest.visitor_id][google.cloud.retail.v2.SearchRequest.visitor_id]
 or [UserInfo.user_id][google.cloud.retail.v2.UserInfo.user_id].

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

 Possible values:

 * `purchased`: Indicates that this product has been purchased before.
        repeated string personal_labels = 7;
        Parameters:
        index - The index to set the value at.
        value - The personalLabels to set.
        Returns:
        This builder for chaining.

      • addPersonalLabels

        public SearchResponse.SearchResult.Builder addPersonalLabels​(String value)
         Specifies previous events related to this product for this user based on
 [UserEvent][google.cloud.retail.v2.UserEvent] with same
 [SearchRequest.visitor_id][google.cloud.retail.v2.SearchRequest.visitor_id]
 or [UserInfo.user_id][google.cloud.retail.v2.UserInfo.user_id].

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

 Possible values:

 * `purchased`: Indicates that this product has been purchased before.
        repeated string personal_labels = 7;
        Parameters:
        value - The personalLabels to add.
        Returns:
        This builder for chaining.

      • addAllPersonalLabels

        public SearchResponse.SearchResult.Builder addAllPersonalLabels​(Iterable<String> values)
         Specifies previous events related to this product for this user based on
 [UserEvent][google.cloud.retail.v2.UserEvent] with same
 [SearchRequest.visitor_id][google.cloud.retail.v2.SearchRequest.visitor_id]
 or [UserInfo.user_id][google.cloud.retail.v2.UserInfo.user_id].

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

 Possible values:

 * `purchased`: Indicates that this product has been purchased before.
        repeated string personal_labels = 7;
        Parameters:
        values - The personalLabels to add.
        Returns:
        This builder for chaining.

      • clearPersonalLabels

        public SearchResponse.SearchResult.Builder clearPersonalLabels()
         Specifies previous events related to this product for this user based on
 [UserEvent][google.cloud.retail.v2.UserEvent] with same
 [SearchRequest.visitor_id][google.cloud.retail.v2.SearchRequest.visitor_id]
 or [UserInfo.user_id][google.cloud.retail.v2.UserInfo.user_id].

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

 Possible values:

 * `purchased`: Indicates that this product has been purchased before.
        repeated string personal_labels = 7;
        Returns:
        This builder for chaining.

      • addPersonalLabelsBytes

        public SearchResponse.SearchResult.Builder addPersonalLabelsBytes​(com.google.protobuf.ByteString value)
         Specifies previous events related to this product for this user based on
 [UserEvent][google.cloud.retail.v2.UserEvent] with same
 [SearchRequest.visitor_id][google.cloud.retail.v2.SearchRequest.visitor_id]
 or [UserInfo.user_id][google.cloud.retail.v2.UserInfo.user_id].

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

 Possible values:

 * `purchased`: Indicates that this product has been purchased before.
        repeated string personal_labels = 7;
        Parameters:
        value - The bytes of the personalLabels to add.
        Returns:
        This builder for chaining.

      • mergeUnknownFields

        public final SearchResponse.SearchResult.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchResponse.SearchResult.Builder>