Method: projects.locations.collections.updateDataConnector

Updates a DataConnector.

HTTP request

PATCH https://discoveryengine.googleapis.com/v1alpha/{dataConnector.name=projects/*/locations/*/collections/*/dataConnector}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
dataConnector.name

string

Output only. The full resource name of the data Connector. Format: projects/*/locations/*/collections/*/dataConnector.

Query parameters

Parameters
updateMask

string (FieldMask format)

Indicates which fields in the provided DataConnector to update.

Supported field paths include:

  • refreshInterval
  • params
  • autoRunDisabled
  • actionConfig
  • actionConfig.action_params
  • actionConfig.service_name
  • destinationConfigs
  • blockingReasons
  • syncMode
  • incrementalSyncDisabled
  • incrementalRefreshInterval

Note: Support for these fields may vary depending on the connector type. For example, not all connectors support destinationConfigs.

If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of DataConnector.

Response body

If successful, the response body contains an instance of DataConnector.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.dataConnectors.update

For more information, see the IAM documentation.