dataplex-get-data-product

A “dataplex-get-data-product” tool allows to retrieve a specific Data Product.

2 minute read

About

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

View the Data Products guide for more information.

This tool can be used with the following database sources:

Source Name
Knowledge Catalog (formerly known as Dataplex) Source

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.

The dataplex-get-data-product 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 Data Product.

kind: tool
name: get_data_product
type: dataplex-get-data-product
source: my-dataplex-source
description: Use this tool to retrieve a Data Product.

field	type	required	description
type	string	true	Must be “dataplex-get-data-product”.
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.

Was this page helpful?

Sorry to hear that. Please tell us how we can improve.