gcloud alpha dataplex datascans describe Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha dataplex datascans describe - describe a Dataplex datascan resource
- SYNOPSIS
gcloud alpha dataplex datascans describe(DATASCAN:--location=LOCATION)[--view=VIEW][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(ALPHA)Displays all details of a Dataplex Datascan resource givena valid Datascan ID.- EXAMPLES
- To describe a Dataplex Datascan
test-datascanin projecttest-projectlocationus-central1, run:gcloudalphadataplexdatascansdescribetest-datascan--project=test-project--location=us-central1 - POSITIONAL ARGUMENTS
- Datascan resource - Arguments and flags that define the Dataplex Datascan youwant to retrieve. The arguments in this group can be used to specify theattributes of this resource. (NOTE) Some attributes are not given arguments inthis group but can be set in other ways.
To set the
projectattribute:- provide the argument
datascanon the command line with a fullyspecified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
DATASCAN- ID of the datascan or fully qualified identifier for the datascan.
To set the
datascanattribute:- provide the argument
datascanon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--location=LOCATION- Location of the Dataplex resource.To set the
locationattribute:- provide the argument
datascanon the command line with a fullyspecified name; - provide the argument
--locationon the command line; - set the property
dataplex/location.
- provide the argument
- provide the argument
- Datascan resource - Arguments and flags that define the Dataplex Datascan youwant to retrieve. The arguments in this group can be used to specify theattributes of this resource. (NOTE) Some attributes are not given arguments inthis group but can be set in other ways.
- FLAGS
--view=VIEW- Displays spec data based on the argument value. The default view is 'basic'.
VIEWmust be one of:basic- Does not include spec data in response.
full- Includes spec data in response.
- 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 helpfor details. - API REFERENCE
- This command uses the
dataplex/v1API. The full documentation forthis API can be found at:https://cloud.google.com/dataplex/docs - NOTES
- This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. This variant is also available:
gclouddataplexdatascansdescribe
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.