Google Cloud Retail V2 Client - Class CreateControlRequest (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

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}

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
TypeDescription
string

setParent

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

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getControl

Required. The Control to create.

Generated from protobuf field .google.cloud.retail.v2.Control control = 2 [(.google.api.field_behavior) = REQUIRED];

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

hasControl

clearControl

setControl

Required. The Control to create.

Generated from protobuf field .google.cloud.retail.v2.Control control = 2 [(.google.api.field_behavior) = REQUIRED];

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]-_/.

Generated from protobuf field string control_id = 3 [(.google.api.field_behavior) = REQUIRED];

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]-_/.

Generated from protobuf field string control_id = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var string
Returns
TypeDescription
$this