Resource: 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
.
JSON representation |
---|
{ "name": string, "displayName": string, "associatedServingConfigIds": [ string ], "solutionType": enum ( |
Fields | |
---|---|
name |
Immutable. Fully qualified name |
displayName |
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. |
associatedServingConfigIds[] |
Output only. List of all |
solutionType |
Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. |
useCases[] |
Specifies the use case for the control. Affects what condition fields can be set. Only applies to |
conditions[] |
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. |
Union field Required. |
|
boostAction |
Defines a boost-type control |
filterAction |
Defines a filter-type control Currently not supported by Recommendation |
redirectAction |
Defines a redirect-type control. |
synonymsAction |
Treats a group of terms as synonyms of one another. |
Methods |
|
---|---|
|
Creates a Control. |
|
Deletes a Control. |
|
Gets a Control. |
|
Lists all Controls by their parent DataStore . |
|
Updates a Control. |