gcloud_alpha_dlp_job-triggers_create (1)

NAME

gcloud alpha dlp job-triggers create - creates a Cloud DLP job trigger

SYNOPSIS

gcloud alpha dlp job-triggers create JOB_TRIGGER --trigger-schedule=TRIGGER_SCHEDULE (--datastore-kind=DATASTORE_KIND | --input-table=INPUT_TABLE | --path=PATH) (--output-table=[OUTPUT_TABLE,...] | --output-topics=[OUTPUT_TOPICS,...]) [--description=DESCRIPTION] [--display-name=DISPLAY_NAME] [--exclude-info-types] [--include-quote] [--info-types=[INFOTYPE,...]] [--max-findings=MAX_FINDINGS] [--max-findings-per-item=MAX_FINDINGS_PER_ITEM] [--min-likelihood=MIN_LIKELIHOOD; default="possible"] [GCLOUD_WIDE_FLAG ...]

DESCRIPTION

(ALPHA) Creates a Cloud DLP job trigger.

POSITIONAL ARGUMENTS

Job trigger resource - The Cloud DLP job trigger to create. The job trigger name can contain uppercase and lowercase letters, numbers, and hyphens -- that is, it must match the regular expression:[a-zA-Z\\d-]+. The maximum length is 100 characters. If not supplied, the system generates one. 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 [job_trigger] 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.

JOB_TRIGGER

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

REQUIRED FLAGS

--trigger-schedule=TRIGGER_SCHEDULE

Duration specifying how often the triggered job will be run. A scheduled start time will be skipped if the previous execution has not ended when its scheduled time occurs. Value must be a time duration greater than or equal to 60 minutes and can be no longer than 60 days.
See $ gcloud topic datetimes for information on duration formats.

Exactly one of these must be specified:

--datastore-kind=DATASTORE_KIND

The Cloud Datastore kind or table to scan. The kind can optionally be prefixed with the Cloud Datastore namespace ID - for example namespace:example-kind or simply example-kind

--input-table=INPUT_TABLE

BigQuery table to scan. BigQuery tables are uniquely identified by their project_id, dataset_id, and table_id in the format <project_id>.<dataset_id>.<table_id>.

--path=PATH

Google Cloud Storage URL to scan for files with optional wildcard character (*) -- for example, gs://my-bucket/*.

Exactly one of these must be specified:

--output-table=[OUTPUT_TABLE,...]

Publishes results of a Cloud DLP job a BigQuery table. BigQuery tables are uniquely identified by their project_id, dataset_id, and table_id in the format <project_id>.<dataset_id>.<table_id>.

--output-topics=[OUTPUT_TOPICS,...]

Publishes the results of a Cloud DLP job to one or more Cloud Pub/Sub topics.
Note: The topic must have given publishing access rights to the DLP API service account executing the Cloud DLP job.

OPTIONAL FLAGS

--description=DESCRIPTION

User provided description (maximum 256 characters)

--display-name=DISPLAY_NAME

Display name of the job trigger (maximum 100 characters)

--exclude-info-types

Whether or not to exclude type information of the findings. Type information is included by default.

--include-quote

If True, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f**".

--info-types=[INFOTYPE,...]

Which infoTypes to scan input for. The values must correspond to infoType values found in documentation. For more information about valid infoTypes, see infoTypes Reference (cloud.google.com/dlp/docs/infotypes-reference

--max-findings=MAX_FINDINGS

Maximum number of findings that will be returned per execution.
If not specified, no limits are applied.

--max-findings-per-item=MAX_FINDINGS_PER_ITEM

Maximum number of findings that will be returned for each item scanned.
If not specified, no limits are applied.

--min-likelihood=MIN_LIKELIHOOD; default="possible"

Only return findings equal to or above this threshold. MIN_LIKELIHOOD must be one of: likely, possible, unlikely, very-likely, very-unlikely.

GCLOUD WIDE FLAGS

These flags are available to all commands: --account, --configuration, --flags-file, --flatten, --format, --help, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity. Run $ gcloud help for details.

API REFERENCE

This command uses the dlp/v2 API. The full documentation for this API can be found at: cloud.google.com/dlp/docs

EXAMPLES

The following command creates a job trigger named my_job_trigger:

$ gcloud alpha dlp job-triggers create my_job_trigger \
    --display-name Daily_Inspect_Trigger \
    --description 'My New Trigger' \
    --input-table myproject.mydataset.input \
    --output-topics my-topic --max-findings-per-item 3 \
    --max-findings 1000 \
    --info-types PHONE_NUMBER,US_DRIVERS_LICENSE \
    --min-likelihood very-likely --include-quote \
    --exclude-info-types --trigger-schedule 8400s

NOTES

This command is currently in ALPHA and may change without notice. If this command fails with API permission errors despite specifying the right project, you will have to apply for early access and have your projects registered on the API whitelist to use it. To do so, contact Support at cloud.google.com/support