dataplex-get-data-profile
2 minute read
About
A dataplex-get-data-profile tool retrieves the results of a completed Data Profile scan.
WARNING: You must verify the execution run has succeeded (via dataplex-get-run-status) before calling this tool, otherwise the results will be empty.
CRITICAL: Access the results via the nested public fields dataProfileResult.profile.fields inside the returned DataScan.
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][dataplex-docs].
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-profile tool accepts the following parameters:
| field | type | required | description |
|---|---|---|---|
| scanId | string | true | The unique ID of the Dataplex profile scan (e.g. nq-prof-12345). |
| location | string | true | The Google Cloud region where the scan was created (e.g. us-central1). |
Example
kind: tool
name: get_data_profile
type: dataplex-get-data-profile
source: my-dataplex-source
description: Fetch results of a completed data profile scan.
Reference
| field | type | required | description |
|---|---|---|---|
| type | string | true | Must be “dataplex-get-data-profile”. |
| 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.