Google Cloud Discovery Engine V1 Client - Class CreateControlRequest (1.5.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
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ parentstring

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}.

↳ controlControl

Required. The Control to create.

↳ control_idstring

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
TypeDescription
string

setParent

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}.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getControl

Required. The Control to create.

Returns
TypeDescription
Control|null

hasControl

clearControl

setControl

Required. The Control to create.

Parameter
NameDescription
varControl
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 must be within 1-63 characters. 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 must be within 1-63 characters. Valid characters are /[a-z][0-9]-_/.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parentstring

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.

controlControl

Required. The Control to create.

controlIdstring

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
TypeDescription
CreateControlRequest