Reference documentation and code samples for the Google Cloud Retail V2 Client class AddControlRequest.
Request for AddControl method.
Generated from protobuf message google.cloud.retail.v2.AddControlRequest
Namespace
Google \ Cloud \ Retail \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ serving_config
string
Required. The source ServingConfig resource name . Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
↳ control_id
string
Required. The id of the control to apply. Assumed to be in the same catalog as the serving config - if id is not found a NOT_FOUND error is returned.
getServingConfig
Required. The source ServingConfig resource name . Format:
projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
Returns
Type
Description
string
setServingConfig
Required. The source ServingConfig resource name . Format:
projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getControlId
Required. The id of the control to apply. Assumed to be in the same catalog
as the serving config - if id is not found a NOT_FOUND error is returned.
Returns
Type
Description
string
setControlId
Required. The id of the control to apply. Assumed to be in the same catalog
as the serving config - if id is not found a NOT_FOUND error is returned.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
servingConfig
string
Required. The source ServingConfig resource name . Format:
projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
Please see ServingConfigServiceClient::servingConfigName() for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Google Cloud Retail V2 Client - Class AddControlRequest (2.3.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.1 (latest)](/php/docs/reference/cloud-retail/latest/V2.AddControlRequest)\n- [2.3.0](/php/docs/reference/cloud-retail/2.3.0/V2.AddControlRequest)\n- [2.2.1](/php/docs/reference/cloud-retail/2.2.1/V2.AddControlRequest)\n- [2.1.3](/php/docs/reference/cloud-retail/2.1.3/V2.AddControlRequest)\n- [2.0.0](/php/docs/reference/cloud-retail/2.0.0/V2.AddControlRequest)\n- [1.7.0](/php/docs/reference/cloud-retail/1.7.0/V2.AddControlRequest)\n- [1.6.4](/php/docs/reference/cloud-retail/1.6.4/V2.AddControlRequest)\n- [1.5.0](/php/docs/reference/cloud-retail/1.5.0/V2.AddControlRequest)\n- [1.4.2](/php/docs/reference/cloud-retail/1.4.2/V2.AddControlRequest)\n- [1.3.1](/php/docs/reference/cloud-retail/1.3.1/V2.AddControlRequest)\n- [1.2.1](/php/docs/reference/cloud-retail/1.2.1/V2.AddControlRequest)\n- [1.1.1](/php/docs/reference/cloud-retail/1.1.1/V2.AddControlRequest)\n- [1.0.1](/php/docs/reference/cloud-retail/1.0.1/V2.AddControlRequest) \nReference documentation and code samples for the Google Cloud Retail V2 Client class AddControlRequest.\n\nRequest for AddControl method.\n\nGenerated from protobuf message `google.cloud.retail.v2.AddControlRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Retail \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getServingConfig\n\nRequired. The source ServingConfig resource name . Format:\n`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`\n\n### setServingConfig\n\nRequired. The source ServingConfig resource name . Format:\n`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`\n\n### getControlId\n\nRequired. The id of the control to apply. Assumed to be in the same catalog\nas the serving config - if id is not found a NOT_FOUND error is returned.\n\n### setControlId\n\nRequired. The id of the control to apply. Assumed to be in the same catalog\nas the serving config - if id is not found a NOT_FOUND error is returned.\n\n### static::build"]]