Google Cloud Discovery Engine V1 Client - Class SetUpDataConnectorRequest (1.17.0)

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

Request for DataConnectorService.SetUpDataConnector method.

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

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent of Collection, in the format of projects/{project}/locations/{location}.

↳ collection_id string

Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. Should conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

↳ collection_display_name string

Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.

↳ data_connector DataConnector

Required. The DataConnector to initialize in the newly created Collection.

getParent

Required. The parent of Collection, in the format of projects/{project}/locations/{location}.

Returns
Type Description
string

setParent

Required. The parent of Collection, in the format of projects/{project}/locations/{location}.

Parameter
Name Description
var string
Returns
Type Description
$this

getCollectionId

Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection.

Should conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Returns
Type Description
string

setCollectionId

Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection.

Should conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Parameter
Name Description
var string
Returns
Type Description
$this

getCollectionDisplayName

Required. The display name of the Collection.

Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.

Returns
Type Description
string

setCollectionDisplayName

Required. The display name of the Collection.

Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.

Parameter
Name Description
var string
Returns
Type Description
$this

getDataConnector

Required. The DataConnector to initialize in the newly created Collection.

Returns
Type Description
DataConnector|null

hasDataConnector

clearDataConnector

setDataConnector

Required. The DataConnector to initialize in the newly created Collection.

Parameter
Name Description
var DataConnector
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The parent of Collection, in the format of projects/{project}/locations/{location}. Please see DataConnectorServiceClient::locationName() for help formatting this field.

collectionId string

Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection.

Should conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

collectionDisplayName string

Required. The display name of the Collection.

Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.

dataConnector DataConnector

Required. The DataConnector to initialize in the newly created Collection.

Returns
Type Description
SetUpDataConnectorRequest