Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet.
A facet result.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#dynamic_facet
def dynamic_facet() -> ::Boolean
Returns
- (::Boolean) — Whether the facet is dynamically generated.
#dynamic_facet=
def dynamic_facet=(value) -> ::Boolean
Parameter
- value (::Boolean) — Whether the facet is dynamically generated.
Returns
- (::Boolean) — Whether the facet is dynamically generated.
#key
def key() -> ::String
Returns
-
(::String) — The key for this facet. For example,
"colors"or"price". It matches SearchRequest.FacetSpec.FacetKey.key.
#key=
def key=(value) -> ::String
Parameter
-
value (::String) — The key for this facet. For example,
"colors"or"price". It matches SearchRequest.FacetSpec.FacetKey.key.
Returns
-
(::String) — The key for this facet. For example,
"colors"or"price". It matches SearchRequest.FacetSpec.FacetKey.key.
#values
def values() -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>
Returns
- (::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>) — The facet values for this field.
#values=
def values=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>
Parameter
- value (::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>) — The facet values for this field.
Returns
- (::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>) — The facet values for this field.