Google Cloud Discovery Engine V1 Client - Class Facet (0.8.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class Facet.

A facet result.

Generated from protobuf message google.cloud.discoveryengine.v1.SearchResponse.Facet

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ SearchResponse

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ key string

The key for this facet. E.g., "colors" or "price". It matches SearchRequest.FacetSpec.FacetKey.key.

↳ values array<Google\Cloud\DiscoveryEngine\V1\SearchResponse\Facet\FacetValue>

The facet values for this field.

↳ dynamic_facet bool

Whether the facet is dynamically generated.

getKey

The key for this facet. E.g., "colors" or "price". It matches SearchRequest.FacetSpec.FacetKey.key.

Returns
TypeDescription
string

setKey

The key for this facet. E.g., "colors" or "price". It matches SearchRequest.FacetSpec.FacetKey.key.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getValues

The facet values for this field.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setValues

The facet values for this field.

Parameter
NameDescription
var array<Google\Cloud\DiscoveryEngine\V1\SearchResponse\Facet\FacetValue>
Returns
TypeDescription
$this

getDynamicFacet

Whether the facet is dynamically generated.

Returns
TypeDescription
bool

setDynamicFacet

Whether the facet is dynamically generated.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this