Package com.google.cloud.retail.v2

Interface SearchResponse.Facet.FacetValueOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      long getCount()
      Number of items that have this facet value.
      SearchResponse.Facet.FacetValue.FacetValueCase getFacetValueCase()  
      Interval getInterval()
      Interval value for a facet, such as [10, 20) for facet "price".
      IntervalOrBuilder getIntervalOrBuilder()
      Interval value for a facet, such as [10, 20) for facet "price".
      double getMaxValue()
      The maximum value in the [FacetValue.interval][google.cloud.retail.v2.SearchResponse.Facet.FacetValue.interval].
      double getMinValue()
      The minimum value in the [FacetValue.interval][google.cloud.retail.v2.SearchResponse.Facet.FacetValue.interval].
      String getValue()
      Text value of a facet, such as "Black" for facet "colorFamilies".
      com.google.protobuf.ByteString getValueBytes()
      Text value of a facet, such as "Black" for facet "colorFamilies".
      boolean hasInterval()
      Interval value for a facet, such as [10, 20) for facet "price".
      boolean hasValue()
      Text value of a facet, such as "Black" for facet "colorFamilies".

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • hasValue

        boolean hasValue()
         Text value of a facet, such as "Black" for facet "colorFamilies".
        string value = 1;
        Returns:
        Whether the value field is set.

      • getValue

        String getValue()
         Text value of a facet, such as "Black" for facet "colorFamilies".
        string value = 1;
        Returns:
        The value.

      • getValueBytes

        com.google.protobuf.ByteString getValueBytes()
         Text value of a facet, such as "Black" for facet "colorFamilies".
        string value = 1;
        Returns:
        The bytes for value.

      • hasInterval

        boolean hasInterval()
         Interval value for a facet, such as [10, 20) for facet "price".
        .google.cloud.retail.v2.Interval interval = 2;
        Returns:
        Whether the interval field is set.

      • getInterval

        Interval getInterval()
         Interval value for a facet, such as [10, 20) for facet "price".
        .google.cloud.retail.v2.Interval interval = 2;
        Returns:
        The interval.

      • getIntervalOrBuilder

        IntervalOrBuilder getIntervalOrBuilder()
         Interval value for a facet, such as [10, 20) for facet "price".
        .google.cloud.retail.v2.Interval interval = 2;

      • getCount

        long getCount()
         Number of items that have this facet value.
        int64 count = 3;
        Returns:
        The count.

      • getMinValue

        double getMinValue()
         The minimum value in the
 [FacetValue.interval][google.cloud.retail.v2.SearchResponse.Facet.FacetValue.interval].
 Only supported on numerical facets and returned if
 [SearchRequest.FacetSpec.FacetKey.return_min_max][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.return_min_max]
 is true.
        double min_value = 5;
        Returns:
        The minValue.

      • getMaxValue

        double getMaxValue()
         The maximum value in the
 [FacetValue.interval][google.cloud.retail.v2.SearchResponse.Facet.FacetValue.interval].
 Only supported on numerical facets and returned if
 [SearchRequest.FacetSpec.FacetKey.return_min_max][google.cloud.retail.v2.SearchRequest.FacetSpec.FacetKey.return_min_max]
 is true.
        double max_value = 6;
        Returns:
        The maxValue.