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

Inherits:
Object
  • Object
show all
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 collapse

Instance Attribute Details

#count ⇒ ::Integer

Returns Number of items that have this facet value.

Returns:

  • (::Integer) —

    Number of items that have this facet value.



1169
1170
1171
1172
 
# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 1169

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

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.



1169
1170
1171
1172
 
# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 1169

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:



1169
1170
1171
1172
 
# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 1169

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:



1169
1170
1171
1172
 
# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 1169

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

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.



1169
1170
1171
1172
 
# File 'proto_docs/google/cloud/retail/v2/search_service.rb', line 1169

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