HEX
Server: Apache/2.4.65 (Ubuntu)
System: Linux ielts-store-v2 6.8.0-1036-gcp #38~22.04.1-Ubuntu SMP Thu Aug 14 01:19:18 UTC 2025 x86_64
User: root (0)
PHP: 7.2.34-54+ubuntu20.04.1+deb.sury.org+1
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,
Upload Files
File: //snap/google-cloud-cli/394/help/man/man1/gcloud_alpha_dataplex_datascans_jobs_describe.1
.TH "GCLOUD_ALPHA_DATAPLEX_DATASCANS_JOBS_DESCRIBE" 1



.SH "NAME"
.HP
gcloud alpha dataplex datascans jobs describe \- describe a Dataplex datascan job



.SH "SYNOPSIS"
.HP
\f5gcloud alpha dataplex datascans jobs describe\fR (\fIJOB\fR\ :\ \fB\-\-datascan\fR=\fIDATASCAN\fR\ \fB\-\-location\fR=\fILOCATION\fR) [\fB\-\-view\fR=\fIVIEW\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Describe a Dataplex datascan job.

Displays all details of a Dataplex job given a valid job ID.



.SH "EXAMPLES"

To describe a Dataplex job \f5test\-job\fR running a datascan
\f5test\-datascan\fR in location \f5us\-central1\fR, run:

.RS 2m
$ gcloud alpha dataplex datascans jobs describe test\-job \e
    \-\-location=us\-central1 \-\-datascan=test\-datascan
.RE

To describe the details of Dataplex job \f5test\-job\fR running a datascan
\f5test\-datascan\fR in location \f5us\-central1\fR, run:

.RS 2m
$ gcloud alpha dataplex datascans jobs describe test\-job \e
    \-\-location=us\-central1 \-\-datascan=test\-datascan \-\-view=FULL
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Job resource \- Arguments and flags that define the Dataplex Job running a
particular Datascan you want to retrieve. The arguments in this group can be
used to specify the attributes of this resource. (NOTE) Some attributes are not
given arguments in this group but can be set in other ways.

To set the \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5job\fR on the command line with a fully specified name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIJOB\fR

ID of the job or fully qualified identifier for the job.

To set the \f5job\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5job\fR on the command line.
.RE
.sp

This positional argument must be specified if any of the other arguments in this
group are specified.

.TP 2m
\fB\-\-datascan\fR=\fIDATASCAN\fR

Datascan ID of the Dataplex datascan resource.


To set the \f5datascan\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5job\fR on the command line with a fully specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-datascan\fR on the command line.
.RE
.sp

.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

Location of the Dataplex resource.


To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5job\fR on the command line with a fully specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line;
.IP "\(bu" 2m
set the property \f5dataplex/location\fR.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-view\fR=\fIVIEW\fR

Displays spec and result data based on the argument value. The default view is
\'basic'. \fIVIEW\fR must be one of:

.RS 2m
.TP 2m
\fBbasic\fR
Does not include spec and result data in response.

.TP 2m
\fBfull\fR
Includes spec and result data in response.

.RE
.sp



.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "API REFERENCE"

This command uses the \fBdataplex/v1\fR API. The full documentation for this API
can be found at: https://cloud.google.com/dataplex/docs



.SH "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:

.RS 2m
$ gcloud dataplex datascans jobs describe
.RE