File: //snap/google-cloud-cli/current/lib/surface/dataplex/datascans/jobs/describe.yaml
- release_tracks: [ALPHA, GA]
help_text:
brief: |
Describe a Dataplex datascan job.
description: |
Describe a Dataplex datascan job.
Displays all details of a Dataplex job given a valid job ID.
examples: |
To describe a Dataplex job `test-job` running a datascan `test-datascan` in
location `us-central1`, run:
$ {command} test-job --location=us-central1 --datascan=test-datascan
To describe the details of Dataplex job `test-job` running a datascan `test-datascan` in
location `us-central1`, run:
$ {command} test-job --location=us-central1 --datascan=test-datascan --view=FULL
request:
ALPHA:
api_version: v1
collection: dataplex.projects.locations.dataScans.jobs
method: get
arguments:
resource:
help_text: |
Arguments and flags that define the Dataplex Job running a particular Datascan you want to retrieve.
spec: !REF googlecloudsdk.command_lib.dataplex.resources:datascanjob
params:
- arg_name: view
api_field: view
help_text: |
Displays spec and result data based on the argument value. The default view is 'basic'.
choices:
- enum_value: BASIC
arg_value: basic
help_text: |
Does not include spec and result data in response.
- enum_value: FULL
arg_value: full
help_text: |
Includes spec and result data in response.