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

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
Name Description
data array

Optional. Data for populating the Message object.

↳ key string

The key for this facet. For example, "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. For example, "colors" or "price". It matches SearchRequest.FacetSpec.FacetKey.key.

Returns
Type Description
string

setKey

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

Parameter
Name Description
var string
Returns
Type Description
$this

getValues

The facet values for this field.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setValues

The facet values for this field.

Parameter
Name Description
var array<Google\Cloud\DiscoveryEngine\V1\SearchResponse\Facet\FacetValue>
Returns
Type Description
$this

getDynamicFacet

Whether the facet is dynamically generated.

Returns
Type Description
bool

setDynamicFacet

Whether the facet is dynamically generated.

Parameter
Name Description
var bool
Returns
Type Description
$this