Google Cloud Retail V2 Client - Class CreateControlRequest (1.5.0)

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

Request for CreateControl method.

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

Namespace

Google \ Cloud \ Retail \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. Full resource name of parent catalog. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

↳ control Google\Cloud\Retail\V2\Control

Required. The Control to create.

↳ control_id string

Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-_/.

getParent

Required. Full resource name of parent catalog. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

Returns
TypeDescription
string

setParent

Required. Full resource name of parent catalog. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getControl

Required. The Control to create.

Returns
TypeDescription
Google\Cloud\Retail\V2\Control|null

hasControl

clearControl

setControl

Required. The Control to create.

Parameter
NameDescription
var Google\Cloud\Retail\V2\Control
Returns
TypeDescription
$this

getControlId

Required. The ID to use for the Control, which will become the final component of the Control's resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-_/.

Returns
TypeDescription
string

setControlId

Required. The ID to use for the Control, which will become the final component of the Control's resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-_/.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parent string

Required. Full resource name of parent catalog. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id} Please see Google\Cloud\Retail\V2\ControlServiceClient::catalogName() for help formatting this field.

control Google\Cloud\Retail\V2\Control

Required. The Control to create.

controlId string

Required. The ID to use for the Control, which will become the final component of the Control's resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-_/.

Returns
TypeDescription
Google\Cloud\Retail\V2\CreateControlRequest