# Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::SearchResponse::Facet (v2.8.0)

2.8.0 (latest) 2.7.0 2.6.2 2.5.0 2.4.0 2.3.1 2.2.0 2.1.1 2.0.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.2 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.2 0.3.0 0.2.0 0.1.0 Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1/latest/Google-Cloud-DiscoveryEngine-V1-SearchRequest-FacetSpec-FacetKey#Google__Cloud__DiscoveryEngine__V1__SearchRequest__FacetSpec__FacetKey_key_instance_ "Google::Cloud::DiscoveryEngine::V1::SearchRequest::FacetSpec::FacetKey#key (method)").

### #key=

    def key=(value) -> ::String

**Parameter**

- **value** (::String) --- The key for this facet. For example, `"colors"` or `"price"`. It matches [SearchRequest.FacetSpec.FacetKey.key](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1/latest/Google-Cloud-DiscoveryEngine-V1-SearchRequest-FacetSpec-FacetKey#Google__Cloud__DiscoveryEngine__V1__SearchRequest__FacetSpec__FacetKey_key_instance_ "Google::Cloud::DiscoveryEngine::V1::SearchRequest::FacetSpec::FacetKey#key (method)").
**Returns**

- (::String) --- The key for this facet. For example, `"colors"` or `"price"`. It matches [SearchRequest.FacetSpec.FacetKey.key](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1/latest/Google-Cloud-DiscoveryEngine-V1-SearchRequest-FacetSpec-FacetKey#Google__Cloud__DiscoveryEngine__V1__SearchRequest__FacetSpec__FacetKey_key_instance_ "Google::Cloud::DiscoveryEngine::V1::SearchRequest::FacetSpec::FacetKey#key (method)").

### #values

    def values() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Facet::FacetValue>

**Returns**

- (::Array\<[::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Facet::FacetValue](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1/latest/Google-Cloud-DiscoveryEngine-V1-SearchResponse-Facet-FacetValue)\>) --- The facet values for this field.

### #values=

    def values=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Facet::FacetValue>

**Parameter**

- **value** (::Array\<[::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Facet::FacetValue](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1/latest/Google-Cloud-DiscoveryEngine-V1-SearchResponse-Facet-FacetValue)\>) --- The facet values for this field.
**Returns**

- (::Array\<[::Google::Cloud::DiscoveryEngine::V1::SearchResponse::Facet::FacetValue](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1/latest/Google-Cloud-DiscoveryEngine-V1-SearchResponse-Facet-FacetValue)\>) --- The facet values for this field.