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

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

Request message for DataConnectorService.UpdateDataConnector method.

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

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ data_connector DataConnector

Required. The DataConnector to update. If the caller does not have permission to update the DataConnector, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataConnector does not exist, a NOT_FOUND error is returned.

↳ update_mask Google\Protobuf\FieldMask

Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval - data_protection_policy Note: Support for these fields may vary depending on the connector type. For example, not all connectors support destination_configs. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.

getDataConnector

Required. The DataConnector to update.

If the caller does not have permission to update the DataConnector, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataConnector does not exist, a NOT_FOUND error is returned.

Returns
Type Description
DataConnector|null

hasDataConnector

clearDataConnector

setDataConnector

Required. The DataConnector to update.

If the caller does not have permission to update the DataConnector, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataConnector does not exist, a NOT_FOUND error is returned.

Parameter
Name Description
var DataConnector
Returns
Type Description
$this

getUpdateMask

Indicates which fields in the provided DataConnector to update.

Supported field paths include:

  • refresh_interval
  • params
  • auto_run_disabled
  • action_config
  • action_config.action_params
  • action_config.service_name
  • destination_configs
  • blocking_reasons
  • sync_mode
  • incremental_sync_disabled
  • incremental_refresh_interval
  • data_protection_policy Note: Support for these fields may vary depending on the connector type. For example, not all connectors support destination_configs. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.
Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Indicates which fields in the provided DataConnector to update.

Supported field paths include:

  • refresh_interval
  • params
  • auto_run_disabled
  • action_config
  • action_config.action_params
  • action_config.service_name
  • destination_configs
  • blocking_reasons
  • sync_mode
  • incremental_sync_disabled
  • incremental_refresh_interval
  • data_protection_policy Note: Support for these fields may vary depending on the connector type. For example, not all connectors support destination_configs. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.
Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

static::build

Parameters
Name Description
dataConnector DataConnector

Required. The DataConnector to update.

If the caller does not have permission to update the DataConnector, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the DataConnector does not exist, a NOT_FOUND error is returned.

updateMask Google\Protobuf\FieldMask

Indicates which fields in the provided DataConnector to update.

Supported field paths include:

  • refresh_interval
  • params
  • auto_run_disabled
  • action_config
  • action_config.action_params
  • action_config.service_name
  • destination_configs
  • blocking_reasons
  • sync_mode
  • incremental_sync_disabled
  • incremental_refresh_interval
  • data_protection_policy

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

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

Returns
Type Description
UpdateDataConnectorRequest