Google Cloud Retail V2 Client - Class Condition (1.0.1)

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

Metadata that is used to define a condition that triggers an action.

A valid condition must specify at least one of 'query_terms' or 'products_filter'. If multiple fields are specified, the condition is met if all the fields are satisfied e.g. if a set of query terms and product_filter are set, then only items matching the product_filter for requests with a query matching the query terms wil get boosted.

Generated from protobuf message google.cloud.retail.v2.Condition

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ query_terms array<Google\Cloud\Retail\V2\Condition\QueryTerm>

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

↳ active_time_range array<Google\Cloud\Retail\V2\Condition\TimeRange>

Range of time(s) specifying when Condition is active. Condition true if any time range matches.

getQueryTerms

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries.

If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

Generated from protobuf field repeated .google.cloud.retail.v2.Condition.QueryTerm query_terms = 1;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setQueryTerms

A list (up to 10 entries) of terms to match the query on. If not specified, match all queries.

If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).

Generated from protobuf field repeated .google.cloud.retail.v2.Condition.QueryTerm query_terms = 1;

Parameter
NameDescription
var array<Google\Cloud\Retail\V2\Condition\QueryTerm>
Returns
TypeDescription
$this

getActiveTimeRange

Range of time(s) specifying when Condition is active.

Condition true if any time range matches.

Generated from protobuf field repeated .google.cloud.retail.v2.Condition.TimeRange active_time_range = 3;

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setActiveTimeRange

Range of time(s) specifying when Condition is active.

Condition true if any time range matches.

Generated from protobuf field repeated .google.cloud.retail.v2.Condition.TimeRange active_time_range = 3;

Parameter
NameDescription
var array<Google\Cloud\Retail\V2\Condition\TimeRange>
Returns
TypeDescription
$this