Google Cloud Retail V2 Client - Class CreateControlRequest (2.1.1)

Version latest

• 2.1.1 (latest)
• 2.1.0
• 2.0.0
• 1.7.0
• 1.6.4
• 1.5.0
• 1.4.2
• 1.3.1
• 1.2.1
• 1.1.1
• 1.0.1

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
Name	Description
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	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
Type	Description
string

setParent

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getControl

Required. The Control to create.

Returns
Type	Description
Control|null

hasControl

clearControl

setControl

Required. The Control to create.

Parameter
Name	Description
var	Control

Returns
Type	Description
$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
Type	Description
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
Name	Description
var	string

Returns
Type	Description
$this

static::build

Parameters
Name	Description
parent	string Required. Full resource name of parent catalog. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id} Please see ControlServiceClient::catalogName() for help formatting this field.
control	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
Type	Description
CreateControlRequest