Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class Control.
Defines a conditioned behavior to employ during serving.
Must be attached to a ServingConfig
to be considered at serving time.
Permitted actions dependent on SolutionType
.
Generated from protobuf message google.cloud.discoveryengine.v1.Control
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ boost_action
↳ filter_action
Google\Cloud\DiscoveryEngine\V1\Control\FilterAction
Defines a filter-type control Currently not supported by Recommendation
↳ redirect_action
↳ synonyms_action
Google\Cloud\DiscoveryEngine\V1\Control\SynonymsAction
Treats a group of terms as synonyms of one another.
↳ name
string
Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*
↳ display_name
string
Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.
↳ associated_serving_config_ids
array
Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.
↳ solution_type
int
Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
↳ use_cases
array
Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH . Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH .
↳ conditions
array< Google\Cloud\DiscoveryEngine\V1\Condition
>
Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.
getBoostAction
Defines a boost-type control
hasBoostAction
setBoostAction
Defines a boost-type control
$this
getFilterAction
Defines a filter-type control Currently not supported by Recommendation
hasFilterAction
setFilterAction
Defines a filter-type control Currently not supported by Recommendation
$this
getRedirectAction
Defines a redirect-type control.
hasRedirectAction
setRedirectAction
Defines a redirect-type control.
$this
getSynonymsAction
Treats a group of terms as synonyms of one another.
hasSynonymsAction
setSynonymsAction
Treats a group of terms as synonyms of one another.
$this
getName
Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*
string
setName
Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*
var
string
$this
getDisplayName
Required. Human readable name. The identifier used in UI views.
Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.
string
setDisplayName
Required. Human readable name. The identifier used in UI views.
Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.
var
string
$this
getAssociatedServingConfigIds
Output only. List of all ServingConfig ids this control is attached to.
May take up to 10 minutes to update after changes.
setAssociatedServingConfigIds
Output only. List of all ServingConfig ids this control is attached to.
May take up to 10 minutes to update after changes.
var
string[]
$this
getSolutionType
Required. Immutable. What solution the control belongs to.
Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
int
setSolutionType
Required. Immutable. What solution the control belongs to.
Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
var
int
$this
getUseCases
Specifies the use case for the control.
Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH . Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH .
setUseCases
Specifies the use case for the control.
Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH . Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH .
var
int[]
$this
getConditions
Determines when the associated action will trigger.
Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.
setConditions
Determines when the associated action will trigger.
Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.
$this
getAction
string
