dataplex-list-data-assets
2 minute read
About
A dataplex-list-data-assets tool retrieves a list of Data Assets associated with a specific Data Product in Knowledge Catalog (formerly known as Dataplex).
View the Data Products guide for more information.
Compatible Sources
This tool can be used with the following database sources:
| Source Name |
|---|
| Knowledge Catalog (formerly known as Dataplex) Source |
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-list-data-assets tool has the following parameters:
| field | type | required | description |
|---|---|---|---|
| locationId | string | true | The location ID (e.g. us, us-central1) of the Data Product. |
| dataProductId | string | true | The unique ID of the parent Data Product. |
| filter | string | false | Filter string to list data assets. |
| pageSize | integer | false | Number of returned data assets in the page. |
| orderBy | string | false | Specifies the ordering of results. |
Example
kind: tool
name: list_data_assets
type: dataplex-list-data-assets
source: my-dataplex-source
description: Use this tool to list Data Assets under a Data Product.
Reference
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be “dataplex-list-data-assets”. |
| source | string | true | Name of the source the tool should execute on. |
| description | string | true | Description of the tool that is passed to the LLM. |
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.