Back to Genai Toolbox

dataplex-update-data-asset

docs/en/integrations/knowledge-catalog/tools/knowledge-catalog-update-data-asset.md

1.7.05.6 KB
Original Source

About

A dataplex-update-data-asset tool updates an existing Data Asset under a Data Product in Knowledge Catalog (formerly known as Dataplex). This is a long-running operation, and the tool returns immediately with the operation's location ID and operation ID.

View the Data Products guide for more information.

Compatible Sources

{{< compatible-sources >}}

Requirements

IAM Permissions

Knowledge Catalog uses Identity and Access Management (IAM) to control user and group access to Knowledge Catalog resources. Toolbox will use your Application Default Credentials (ADC) to authorize and authenticate when interacting with Knowledge Catalog.

In addition to setting the ADC for your server, you need to ensure the IAM identity has been given the correct IAM permissions for the tasks you intend to perform. See Knowledge Catalog IAM permissions and Knowledge Catalog IAM roles for more information on applying IAM permissions and roles to an identity.

Parameters

The dataplex-update-data-asset tool accepts the following parameters:

fieldtyperequireddescription
locationIdstringtrueThe location ID (e.g. us, us-central1) where the parent Data Product is located.
dataProductIdstringtrueThe unique ID of the parent Data Product.
dataAssetIdstringtrueThe unique ID of the Data Asset to update.
labelsmapfalseThe labels associated with the Data Asset. Keys and values must be strings.
accessGroupConfigsmapfalseMap of access group configurations to associate with the Data Asset. Keys represent the access group ID, and the value is a list of string IAM role names (e.g. {"test-group": ["roles/bigquery.dataViewer"]}). To find the list of supported roles that can be granted on the resource, refer to the roles:queryGrantableRoles API method.
updateMaskarrayfalseThe list of fields to update. If not specified, all non-empty fields will be updated.

Example

yaml
kind: tool
name: update_data_asset
type: dataplex-update-data-asset
source: my-dataplex-source
description: Use this tool to update a Data Asset.

Reference

fieldtyperequireddescription
typestringtrueMust be "dataplex-update-data-asset".
sourcestringtrueName of the source the tool should execute on.
descriptionstringtrueDescription of the tool that is passed to the LLM.