gcloud alpha dataplex context lookup

NAME
gcloud alpha dataplex context lookup - looks up metadata that can be used as context by agents
SYNOPSIS
gcloud alpha dataplex context lookup --resources =[RESOURCES,…] [--all-schema-fields ] [--context-format =CONTEXT_FORMAT; default="yaml"] [--location =LOCATION] [--options =OPTIONS] [GCLOUD_WIDE_FLAG]
DESCRIPTION
(ALPHA) Looks up metadata that can be used as context by agents.

Fetches detailed contextual metadata for the specified data assets. Data assets can be identified by their Dataplex entry name. The returned context can include schema, descriptions, business annotations, data quality insights, and relationships, structured for application use. This output is particularly useful for providing grounding to Large Language Models (LLMs), enabling more accurate and context-aware interactions with your data.

EXAMPLES
To look up Dataplex Context for BigQuery tables 'table1' and 'table2' in dataset 'my-dataset' within project 'test-dataplex' in location 'us-central1', run:
gcloudalphadataplexcontextlookup--location=us-central1--project=test-dataplex--resources=resource1,resource2

To look up context using Dataplex entry names:

gcloudalphadataplexcontextlookup--location=us-central1--project=test-dataplex--resources=projects/test-dataplex/locations/us-central1/entryGroups/my-group/entries/my-entry

To look up context using the default project and location from your gcloud configuration:

gcloudalphadataplexcontextlookup--resources=resource1,resource2
REQUIRED FLAGS
--resources=[RESOURCES,…]
The identifier describing the resource, for example: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}
OPTIONAL FLAGS
--all-schema-fields
Includes all schema fields in the context.
--context-format=CONTEXT_FORMAT; default="yaml"
The output format of the command. CONTEXT_FORMAT must be one of: json, xml, yaml.
Location resource - The Dataplex location for the context lookup. If not specified, the location will be taken from the dataplex/location property in your gcloud configuration. This represents a Cloud resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways.

To set the project attribute:

  • provide the argument --location on the command line with a fully specified name;
  • set the property dataplex/location with a fully specified name;
  • provide the argument --project on the command line;
  • set the property core/project.
--location=LOCATION
ID of the location or fully qualified identifier for the location.

To set the location attribute:

  • provide the argument --location on the command line;
  • set the property dataplex/location.
--options=OPTIONS
Additional options for the command. This can be provided as a JSON string. Example: --options='{"key": "value"}'
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file , --account , --billing-project , --configuration , --flags-file , --flatten , --format , --help , --impersonate-service-account , --log-http , --project , --quiet , --trace-token , --user-output-enabled , --verbosity .

Run $ gcloud help for details.

API REFERENCE
This command uses the dataplex/v1 API. The full documentation for this API can be found at: https://cloud.google.com/dataplex/docs
NOTES
This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early access allowlist. This variant is also available:
gclouddataplexcontextlookup 

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026年05月27日 UTC.