Google Cloud Retail V2 Client - Class Control (2.0.0-RC1)

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

Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.

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

Namespace

Google \ Cloud \ Retail \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ rule Google\Cloud\Retail\V2\Rule

A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".

↳ name string

Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*

↳ display_name string

Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.

↳ associated_serving_config_ids array

Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.

↳ solution_types array

Required. Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only SOLUTION_TYPE_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.

↳ search_solution_use_case array

Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control.

getRule

A rule control - a condition-action pair.

Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".

Returns
Type Description
Google\Cloud\Retail\V2\Rule|null

hasRule

setRule

A rule control - a condition-action pair.

Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".

Parameter
Name Description
var Google\Cloud\Retail\V2\Rule
Returns
Type Description
$this

getName

Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*

Returns
Type Description
string

setName

Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

Required. The human readable control display name. Used in Retail UI.

This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.

Returns
Type Description
string

setDisplayName

Required. The human readable control display name. Used in Retail UI.

This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.

Parameter
Name Description
var string
Returns
Type Description
$this

getAssociatedServingConfigIds

Output only. List of serving config ids that are associated with this control in the same Catalog.

Note the association is managed via the ServingConfig, this is an output only denormalized view.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAssociatedServingConfigIds

Output only. List of serving config ids that are associated with this control in the same Catalog.

Note the association is managed via the ServingConfig, this is an output only denormalized view.

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

getSolutionTypes

Required. Immutable. The solution types that the control is used for.

Currently we support setting only one type of solution at creation time. Only SOLUTION_TYPE_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSolutionTypes

Required. Immutable. The solution types that the control is used for.

Currently we support setting only one type of solution at creation time. Only SOLUTION_TYPE_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.

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

getSearchSolutionUseCase

Specifies the use case for the control.

Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setSearchSolutionUseCase

Specifies the use case for the control.

Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control.

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

getControl

Returns
Type Description
string