Google Cloud Discovery Engine V1 Client - Class CreateControlRequest (1.3.1)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class CreateControlRequest.

Request for CreateControl method.

Generated from protobuf message google.cloud.discoveryengine.v1.CreateControlRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_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 must be within 1-63 characters. Valid characters are /[a-z][0-9]-_/.

getParent

Required. Full resource name of parent data store. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id} or projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

Returns
Type	Description
`string`

setParent

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 must be within 1-63 characters. 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 must be within 1-63 characters. 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 data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Please see ControlServiceClient::dataStoreName() 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 must be within 1-63 characters. Valid characters are /[a-z][0-9]-_/.

Returns
Type	Description
`CreateControlRequest`