Google Cloud Retail V2 Client - Class AddControlRequest (1.7.0)

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 Google\Cloud\Retail\V2\ServingConfigServiceClient::servingConfigName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Retail\V2\AddControlRequest`