Google Cloud Discovery Engine V1 Client - Class Condition (1.3.1)

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

Defines circumstances to be checked before allowing a behavior

Generated from protobuf message google.cloud.discoveryengine.v1.Condition

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ query_terms array<Condition\QueryTerm>

Search only A list of terms to match the query on. Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.

↳ active_time_range array<Condition\TimeRange>

Range of time(s) specifying when condition is active. Maximum of 10 time ranges.

↳ query_regex string

Optional. Query regex to match the whole search query. Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.

getQueryTerms

Search only A list of terms to match the query on.

Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setQueryTerms

Search only A list of terms to match the query on.

Cannot be set when Condition.query_regex is set. Maximum of 10 query terms.

Parameter
Name Description
var array<Condition\QueryTerm>
Returns
Type Description
$this

getActiveTimeRange

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

Maximum of 10 time ranges.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setActiveTimeRange

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

Maximum of 10 time ranges.

Parameter
Name Description
var array<Condition\TimeRange>
Returns
Type Description
$this

getQueryRegex

Optional. Query regex to match the whole search query.

Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.

Returns
Type Description
string

setQueryRegex

Optional. Query regex to match the whole search query.

Cannot be set when Condition.query_terms is set. This is currently supporting promotion use case.

Parameter
Name Description
var string
Returns
Type Description
$this