Google Cloud Retail V2 Client - Class IgnoredFacetValues (2.1.0)

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

Facet values to ignore on facets during the specified time range for the given SearchResponse.Facet.key attribute.

Generated from protobuf message google.cloud.retail.v2.CatalogAttribute.FacetConfig.IgnoredFacetValues

Namespace

Google \ Cloud \ Retail \ V2 \ CatalogAttribute \ FacetConfig

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ values array

List of facet values to ignore for the following time range. The facet values are the same as the attribute values. There is a limit of 10 values per instance of IgnoredFacetValues. Each value can have at most 128 characters.

↳ start_time Google\Protobuf\Timestamp

Time range for the current list of facet values to ignore. If multiple time ranges are specified for an facet value for the current attribute, consider all of them. If both are empty, ignore always. If start time and end time are set, then start time must be before end time. If start time is not empty and end time is empty, then will ignore these facet values after the start time.

↳ end_time Google\Protobuf\Timestamp

If start time is empty and end time is not empty, then ignore these facet values before end time.

getValues

List of facet values to ignore for the following time range. The facet values are the same as the attribute values. There is a limit of 10 values per instance of IgnoredFacetValues. Each value can have at most 128 characters.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setValues

List of facet values to ignore for the following time range. The facet values are the same as the attribute values. There is a limit of 10 values per instance of IgnoredFacetValues. Each value can have at most 128 characters.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getStartTime

Time range for the current list of facet values to ignore.

If multiple time ranges are specified for an facet value for the current attribute, consider all of them. If both are empty, ignore always. If start time and end time are set, then start time must be before end time. If start time is not empty and end time is empty, then will ignore these facet values after the start time.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Time range for the current list of facet values to ignore.

If multiple time ranges are specified for an facet value for the current attribute, consider all of them. If both are empty, ignore always. If start time and end time are set, then start time must be before end time. If start time is not empty and end time is empty, then will ignore these facet values after the start time.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getEndTime

If start time is empty and end time is not empty, then ignore these facet values before end time.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

If start time is empty and end time is not empty, then ignore these facet values before end time.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this