Back to Genai Toolbox

dataplex-get-data-asset

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

1.7.02.7 KB
Original Source

About

A dataplex-get-data-asset tool retrieves detailed metadata for a specific Data Asset in Knowledge Catalog (formerly known as Dataplex).

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-get-data-asset tool has the following parameters:

fieldtyperequireddescription
locationIdstringtrueThe location ID (e.g. us, us-central1) of the Data Product.
dataProductIdstringtrueThe unique ID of the parent Data Product.
dataAssetIdstringtrueThe unique ID of the Data Asset.

Example

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

Reference

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