gcloud-help/gcloud/alpha/dataplex/datascan/create

NAME
    gcloud alpha dataplex datascan create - create a Dataplex Datascan

SYNOPSIS
    gcloud alpha dataplex datascan create (DATASCAN : --location=LOCATION)
        --scan-type=SCAN_TYPE
        (--data-source-entity=DATA_SOURCE_ENTITY
          | --data-source-resource=DATA_SOURCE_RESOURCE)
        [--data-quality-spec-file=DATA_QUALITY_SPEC_FILE]
        [--description=DESCRIPTION] [--display-name=DISPLAY_NAME]
        [--labels=[KEY=VALUE,...]] [--async | --validate-only]
        [--field=FIELD
          --disabled=DISABLED --on-demand=ON_DEMAND --schedule=SCHEDULE]
        [GCLOUD_WIDE_FLAG ...]

DESCRIPTION
    (ALPHA) Create a Dataplex Datascan.

EXAMPLES
    Create a Dataplex datascan job.

    Represents a user-visible job which provides the insights for the related
    data source. For example:
      ▪ Data Quality: generates queries based on the rules and run against
        the data to get data quality check results.
      ▪ Data Profile: analyzes the data in table(s) and generates insights
        about the structure, content and relationships (such as null percent,
        cardinality, min/max/mean, etc).

POSITIONAL ARGUMENTS
     Datascan resource - Arguments and flags that define the Dataplex datascan
     you want to create a Datascan for. 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
     project attribute:
      ◆ provide the argument datascan on the command line with a fully
        specified name;
      ◆ provide the argument --project on 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 dataScans attribute:
          ▸ provide the argument datascan on the command line.

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

       --location=LOCATION
          The location of the Dataplex resource. To set the location attribute:
          ▸ provide the argument datascan on the command line with a fully
            specified name;
          ▸ provide the argument --location on the command line;
          ▸ set the property dataplex/location.

REQUIRED FLAGS
     --scan-type=SCAN_TYPE
        Specify the type of scan. SCAN_TYPE must be one of: PROFILE, QUALITY.

     Data source for the Datascan.

     Exactly one of these must be specified:

       --data-source-entity=DATA_SOURCE_ENTITY
          Dataplex entity that contains the data for the Datascan, of the form:
          projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.

       --data-source-resource=DATA_SOURCE_RESOURCE
          Service-qualified full resource name of the cloud resource that
          contains the data for the Datascan, of the form:
          //bigquery.googleapis.com/projects/{project_number}/datasets/{dataset_id}/tables/{table_id}.

OPTIONAL FLAGS
     Additional configuration arguments for the scan.

       DataQualityScan related setting.

         --data-quality-spec-file=DATA_QUALITY_SPEC_FILE
            path to the JSON file containing the Data Quality Spec for the Data
            Quality Scan

     --description=DESCRIPTION
        Description of the Datascan

     --display-name=DISPLAY_NAME
        Display name of the Datascan

     --labels=[KEY=VALUE,...]
        List of label KEY=VALUE pairs to add.

        Keys must start with a lowercase character and contain only hyphens
        (-), underscores (_), lowercase characters, and numbers. Values must
        contain only hyphens (-), underscores (_), lowercase characters, and
        numbers.

     At most one of --async | --validate-only can be specified.

     At most one of these can be specified:

       --async
          Return immediately, without waiting for the operation in progress to
          complete.

       --validate-only
          Validate the create action, but don't actually perform it.

     Datascan execution settings. If not specified, the fields under it will
     use their default values.

       --field=FIELD
          Field that contains values that monotonically increase over time
          (e.g. timestamp).

       Datascan scheduling and trigger settings

         --disabled=DISABLED
            Prevent the scan from executing (including both scheduled scans and
            scans triggered via RunDataScan API). This does not cancel
            currently running scan jobs. If not specified, the default is
            false.

         --on-demand=ON_DEMAND
            If set, the scan runs one-time shortly after Datascan Creation.

         --schedule=SCHEDULE
            Cron schedule (https://en.wikipedia.org/wiki/Cron) for running
            scans periodically. To explicitly set a timezone to the cron tab,
            apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or
            "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid
            string from IANA time zone database. For example,
            CRON_TZ=America/New_York 1 * * * * or TZ=America/New_York 1 * * *
            *. This field is required for RECURRING scans.

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.

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.