Retail V2 API - Class Google::Cloud::Retail::V2::SearchResponse::Facet::FacetValue (v1.3.0)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::SearchResponse::Facet::FacetValue.

A facet value which contains value names and their count.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#count

def count() -> ::Integer

Returns

(::Integer) — Number of items that have this facet value.

#count=

def count=(value) -> ::Integer

Parameter

value (::Integer) — Number of items that have this facet value.

Returns

(::Integer) — Number of items that have this facet value.

#interval

def interval() -> ::Google::Cloud::Retail::V2::Interval

Returns

(::Google::Cloud::Retail::V2::Interval) — Interval value for a facet, such as [10, 20) for facet "price".

Note: The following fields are mutually exclusive: interval, value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#interval=

def interval=(value) -> ::Google::Cloud::Retail::V2::Interval

Parameter

value (::Google::Cloud::Retail::V2::Interval) — Interval value for a facet, such as [10, 20) for facet "price".

Note: The following fields are mutually exclusive: interval, value. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::Retail::V2::Interval) — Interval value for a facet, such as [10, 20) for facet "price".

Note: The following fields are mutually exclusive: interval, value. If a field in that set is populated, all other fields in the set will automatically be cleared.

#max_value

def max_value() -> ::Float

Returns

(::Float) — The maximum value in the FacetValue.interval. Only supported on numerical facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.

#max_value=

def max_value=(value) -> ::Float

Parameter

value (::Float) — The maximum value in the FacetValue.interval. Only supported on numerical facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.

Returns

(::Float) — The maximum value in the FacetValue.interval. Only supported on numerical facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.

#min_value

def min_value() -> ::Float

Returns

(::Float) — The minimum value in the FacetValue.interval. Only supported on numerical facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.

#min_value=

def min_value=(value) -> ::Float

Parameter

value (::Float) — The minimum value in the FacetValue.interval. Only supported on numerical facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.

Returns

(::Float) — The minimum value in the FacetValue.interval. Only supported on numerical facets and returned if SearchRequest.FacetSpec.FacetKey.return_min_max is true.

#value

def value() -> ::String

Returns

(::String) — Text value of a facet, such as "Black" for facet "colorFamilies".

Note: The following fields are mutually exclusive: value, interval. If a field in that set is populated, all other fields in the set will automatically be cleared.

#value=

def value=(value) -> ::String

Parameter

value (::String) — Text value of a facet, such as "Black" for facet "colorFamilies".

Note: The following fields are mutually exclusive: value, interval. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::String) — Text value of a facet, such as "Black" for facet "colorFamilies".

Note: The following fields are mutually exclusive: value, interval. If a field in that set is populated, all other fields in the set will automatically be cleared.