Google Cloud Retail V2 Client - Class UpdateControlRequest (1.7.0)

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

Request for UpdateControl method.

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

Namespace

Google \ Cloud \ Retail \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ control Google\Cloud\Retail\V2\Control

Required. The Control to update.
↳ update_mask Google\Protobuf\FieldMask

Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name If not set or empty, all supported fields are updated.

getControl

Required. The Control to update.

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

hasControl

clearControl

setControl

Required. The Control to update.

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

getUpdateMask

Indicates which fields in the provided Control to update. The following are NOT supported:

  • Control.name If not set or empty, all supported fields are updated.
Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Indicates which fields in the provided Control to update. The following are NOT supported:

  • Control.name If not set or empty, all supported fields are updated.
Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

static::build

Parameters
Name Description
control Google\Cloud\Retail\V2\Control

Required. The Control to update.
updateMask Google\Protobuf\FieldMask

Indicates which fields in the provided Control to update. The following are NOT supported:

If not set or empty, all supported fields are updated.
Returns
Type Description
Google\Cloud\Retail\V2\UpdateControlRequest