Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class DataConnectorServiceClient.
Service Description: Service for data connector management.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ ClientMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
options |
array|Google\ApiCore\Options\ClientOptions
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
Google\Auth\FetchAuthTokenInterface|Google\ApiCore\CredentialsWrapper
This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|Google\ApiCore\Transport\TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
↳ logger |
false|Psr\Log\LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
↳ universeDomain |
string
The service domain for the client. Defaults to 'googleapis.com'. |
getDataConnector
Gets the DataConnector.
DataConnector is a singleton resource for each Collection.
The async variant is DataConnectorServiceClient::getDataConnectorAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\GetDataConnectorRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DiscoveryEngine\V1\DataConnector |
|
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\DataConnectorServiceClient;
use Google\Cloud\DiscoveryEngine\V1\DataConnector;
use Google\Cloud\DiscoveryEngine\V1\GetDataConnectorRequest;
/**
* @param string $formattedName Full resource name of
* [DataConnector][google.cloud.discoveryengine.v1.DataConnector], such as
* `projects/{project}/locations/{location}/collections/{collection_id}/dataConnector`.
*
* If the caller does not have permission to access the
* [DataConnector][google.cloud.discoveryengine.v1.DataConnector], regardless
* of whether or not it exists, a `PERMISSION_DENIED` error is returned.
*
* If the requested
* [DataConnector][google.cloud.discoveryengine.v1.DataConnector] does not
* exist, a `NOT_FOUND` error is returned. Please see
* {@see DataConnectorServiceClient::dataConnectorName()} for help formatting this field.
*/
function get_data_connector_sample(string $formattedName): void
{
// Create a client.
$dataConnectorServiceClient = new DataConnectorServiceClient();
// Prepare the request message.
$request = (new GetDataConnectorRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var DataConnector $response */
$response = $dataConnectorServiceClient->getDataConnector($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedName = DataConnectorServiceClient::dataConnectorName(
'[PROJECT]',
'[LOCATION]',
'[COLLECTION]'
);
get_data_connector_sample($formattedName);
}
setUpDataConnector
Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method.
The async variant is DataConnectorServiceClient::setUpDataConnectorAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\SetUpDataConnectorRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse<Google\Cloud\DiscoveryEngine\V1\DataConnector> |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\DiscoveryEngine\V1\Client\DataConnectorServiceClient;
use Google\Cloud\DiscoveryEngine\V1\DataConnector;
use Google\Cloud\DiscoveryEngine\V1\SetUpDataConnectorRequest;
use Google\Protobuf\Duration;
use Google\Rpc\Status;
/**
* @param string $formattedParent The parent of
* [Collection][google.cloud.discoveryengine.v1.Collection], in the format of
* `projects/{project}/locations/{location}`. Please see
* {@see DataConnectorServiceClient::locationName()} for help formatting this field.
* @param string $collectionId The ID to use for the
* [Collection][google.cloud.discoveryengine.v1.Collection], which will become
* the final component of the
* [Collection][google.cloud.discoveryengine.v1.Collection]'s resource name. A
* new [Collection][google.cloud.discoveryengine.v1.Collection] is created as
* part of the [DataConnector][google.cloud.discoveryengine.v1.DataConnector]
* setup. [DataConnector][google.cloud.discoveryengine.v1.DataConnector] is a
* singleton resource under
* [Collection][google.cloud.discoveryengine.v1.Collection], managing all
* [DataStore][google.cloud.discoveryengine.v1.DataStore]s of the
* [Collection][google.cloud.discoveryengine.v1.Collection].
*
* Should conform to
* [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length
* limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
* @param string $collectionDisplayName The display name of the
* [Collection][google.cloud.discoveryengine.v1.Collection].
*
* Should be human readable, used to display collections in the Console
* Dashboard. UTF-8 encoded string with limit of 1024 characters.
* @param string $dataConnectorDataSource The identifier for the data source.
* For the full, up-to-date list of supported connectors and their values,
* see
* [Connect a third-party data
* source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage).
*/
function set_up_data_connector_sample(
string $formattedParent,
string $collectionId,
string $collectionDisplayName,
string $dataConnectorDataSource
): void {
// Create a client.
$dataConnectorServiceClient = new DataConnectorServiceClient();
// Prepare the request message.
$dataConnectorRefreshInterval = new Duration();
$dataConnector = (new DataConnector())
->setDataSource($dataConnectorDataSource)
->setRefreshInterval($dataConnectorRefreshInterval);
$request = (new SetUpDataConnectorRequest())
->setParent($formattedParent)
->setCollectionId($collectionId)
->setCollectionDisplayName($collectionDisplayName)
->setDataConnector($dataConnector);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $dataConnectorServiceClient->setUpDataConnector($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var DataConnector $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$formattedParent = DataConnectorServiceClient::locationName('[PROJECT]', '[LOCATION]');
$collectionId = '[COLLECTION_ID]';
$collectionDisplayName = '[COLLECTION_DISPLAY_NAME]';
$dataConnectorDataSource = '[DATA_SOURCE]';
set_up_data_connector_sample(
$formattedParent,
$collectionId,
$collectionDisplayName,
$dataConnectorDataSource
);
}
updateDataConnector
Updates a DataConnector.
The async variant is DataConnectorServiceClient::updateDataConnectorAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\UpdateDataConnectorRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
Google\ApiCore\RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DiscoveryEngine\V1\DataConnector |
|
use Google\ApiCore\ApiException;
use Google\Cloud\DiscoveryEngine\V1\Client\DataConnectorServiceClient;
use Google\Cloud\DiscoveryEngine\V1\DataConnector;
use Google\Cloud\DiscoveryEngine\V1\UpdateDataConnectorRequest;
use Google\Protobuf\Duration;
/**
* @param string $dataConnectorDataSource The identifier for the data source.
* For the full, up-to-date list of supported connectors and their values,
* see
* [Connect a third-party data
* source](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/connect-third-party-data-source#sources-by-launch-stage).
*/
function update_data_connector_sample(string $dataConnectorDataSource): void
{
// Create a client.
$dataConnectorServiceClient = new DataConnectorServiceClient();
// Prepare the request message.
$dataConnectorRefreshInterval = new Duration();
$dataConnector = (new DataConnector())
->setDataSource($dataConnectorDataSource)
->setRefreshInterval($dataConnectorRefreshInterval);
$request = (new UpdateDataConnectorRequest())
->setDataConnector($dataConnector);
// Call the API and handle any network failures.
try {
/** @var DataConnector $response */
$response = $dataConnectorServiceClient->updateDataConnector($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$dataConnectorDataSource = '[DATA_SOURCE]';
update_data_connector_sample($dataConnectorDataSource);
}
getDataConnectorAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\GetDataConnectorRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\DiscoveryEngine\V1\DataConnector> |
|
setUpDataConnectorAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\SetUpDataConnectorRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
updateDataConnectorAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\DiscoveryEngine\V1\UpdateDataConnectorRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\DiscoveryEngine\V1\DataConnector> |
|
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
| Returns | |
|---|---|
| Type | Description |
Google\LongRunning\Client\OperationsClient |
|
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
| Parameters | |
|---|---|
| Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse |
|
static::contentPolicyName
Formats a string containing the fully-qualified path to represent a content_policy resource.
| Parameters | |
|---|---|
| Name | Description |
organization |
string
|
location |
string
|
contentPolicy |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted content_policy resource. |
static::dataConnectorName
Formats a string containing the fully-qualified path to represent a data_connector resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
collection |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted data_connector resource. |
static::dataStoreName
Formats a string containing the fully-qualified path to represent a data_store resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
dataStore |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted data_store resource. |
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted location resource. |
static::organizationLocationContentPolicyName
Formats a string containing the fully-qualified path to represent a organization_location_content_policy resource.
| Parameters | |
|---|---|
| Name | Description |
organization |
string
|
location |
string
|
contentPolicy |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted organization_location_content_policy resource. |
static::projectLocationCollectionDataStoreName
Formats a string containing the fully-qualified path to represent a project_location_collection_data_store resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
collection |
string
|
dataStore |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted project_location_collection_data_store resource. |
static::projectLocationCollectionDataStoreSchemaName
Formats a string containing the fully-qualified path to represent a project_location_collection_data_store_schema resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
collection |
string
|
dataStore |
string
|
schema |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted project_location_collection_data_store_schema resource. |
static::projectLocationContentPolicyName
Formats a string containing the fully-qualified path to represent a project_location_content_policy resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
contentPolicy |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted project_location_content_policy resource. |
static::projectLocationDataStoreName
Formats a string containing the fully-qualified path to represent a project_location_data_store resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
dataStore |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted project_location_data_store resource. |
static::projectLocationDataStoreSchemaName
Formats a string containing the fully-qualified path to represent a project_location_data_store_schema resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
dataStore |
string
|
schema |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted project_location_data_store_schema resource. |
static::schemaName
Formats a string containing the fully-qualified path to represent a schema resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
dataStore |
string
|
schema |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted schema resource. |
static::serviceName
Formats a string containing the fully-qualified path to represent a service resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
namespace |
string
|
service |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted service resource. |
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- contentPolicy: organizations/{organization}/locations/{location}/contentPolicies/{content_policy}
- dataConnector: projects/{project}/locations/{location}/collections/{collection}/dataConnector
- dataStore: projects/{project}/locations/{location}/dataStores/{data_store}
- location: projects/{project}/locations/{location}
- organizationLocationContentPolicy: organizations/{organization}/locations/{location}/contentPolicies/{content_policy}
- projectLocationCollectionDataStore: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}
- projectLocationCollectionDataStoreSchema: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}
- projectLocationContentPolicy: projects/{project}/locations/{location}/contentPolicies/{content_policy}
- projectLocationDataStore: projects/{project}/locations/{location}/dataStores/{data_store}
- projectLocationDataStoreSchema: projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}
- schema: projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}
- service: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
| Parameters | |
|---|---|
| Name | Description |
formattedName |
string
The formatted name string |
template |
?string
Optional name of template to match |
| Returns | |
|---|---|
| Type | Description |
array |
An associative array from name component IDs to component values. |