Class: Google::Cloud::Retail::V2::SearchResponse::Facet::FacetValue

Inherits:

Object

• Object
• Google::Cloud::Retail::V2::SearchResponse::Facet::FacetValue

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/retail/v2/search_service.rb

Overview

A facet value which contains value names and their count.

Instance Attribute Summary

• #count ⇒ ::Integer

  Number of items that have this facet value.

• #interval ⇒ ::Google::Cloud::Retail::V2::Interval

  Interval value for a facet, such as [10, 20) for facet "price".

• #max_value ⇒ ::Float

  The maximum value in the FacetValue.interval.

• #min_value ⇒ ::Float

  The minimum value in the FacetValue.interval.

• #value ⇒ ::String

  Text value of a facet, such as "Black" for facet "colorFamilies".

Instance Attribute Details

#count ⇒ ::Integer

Returns Number of items that have this facet value.

Returns:

• (::Integer) —

  Number of items that have this facet value.

# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 1080

class FacetValue
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#interval ⇒ ::Google::Cloud::Retail::V2::Interval

Returns Interval value for a facet, such as [10, 20) for facet "price".

Returns:

• (::Google::Cloud::Retail::V2::Interval) —

  Interval value for a facet, such as [10, 20) for facet "price".

# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 1080

class FacetValue
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#max_value ⇒ ::Float

Returns 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.

# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 1080

class FacetValue
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#min_value ⇒ ::Float

Returns 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.

# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 1080

class FacetValue
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#value ⇒ ::String

Returns Text value of a facet, such as "Black" for facet "colorFamilies".

Returns:

• (::String) —

  Text value of a facet, such as "Black" for facet "colorFamilies".

# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 1080

class FacetValue
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end