Google Cloud Retail V2 Client - Class Facet (1.0.1)

Reference documentation and code samples for the Google Cloud Retail V2 Client class Facet.

A facet result.

Generated from protobuf message google.cloud.retail.v2.SearchResponse.Facet

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ key
string

The key for this facet. E.g., "colorFamilies" or "price" or "attributes.attr1".

↳ values
array< Google\Cloud\Retail\V2\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., "colorFamilies" or "price" or "attributes.attr1".

Generated from protobuf field string key = 1;

Returns
Type
Description
string

setKey

The key for this facet. E.g., "colorFamilies" or "price" or "attributes.attr1".

Generated from protobuf field string key = 1;

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getValues

The facet values for this field.

Generated from protobuf field repeated .google.cloud.retail.v2.SearchResponse.Facet.FacetValue values = 2;

Returns
Type
Description
Google\Protobuf\Internal\RepeatedField

setValues

The facet values for this field.

Generated from protobuf field repeated .google.cloud.retail.v2.SearchResponse.Facet.FacetValue values = 2;

Parameter
Name
Description
Returns
Type
Description
$this

getDynamicFacet

Whether the facet is dynamically generated.

Generated from protobuf field bool dynamic_facet = 3;

Returns
Type
Description
bool

setDynamicFacet

Whether the facet is dynamically generated.

Generated from protobuf field bool dynamic_facet = 3;

Parameter
Name
Description
var
bool
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: