gcloud alpha data-catalog crawlers create

NAME
gcloud alpha data-catalog crawlers create - create a new Cloud Data Catalog crawler
SYNOPSIS
gcloud alpha data-catalog crawlers create CRAWLER (--crawl-scope=CRAWL_SCOPE : --buckets=[BUCKET,…]) (--run-option=RUN_OPTION : --run-schedule=RUN_SCHEDULE) [--bundle-specs=[PATTERN,…]] [--description=DESCRIPTION] [--display-name=DISPLAY_NAME] [GCLOUD_WIDE_FLAG]
DESCRIPTION
(ALPHA) Create a new Cloud Data Catalog crawler.
POSITIONAL ARGUMENTS
Crawler resource - The crawler to create. 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 [crawler] on the command line with a fully specified name; set the property [core/project]; provide the argument [--project] on the command line. This must be specified.
CRAWLER
ID of the crawler or fully qualified identifier for the crawler.
REQUIRED FLAGS
Arguments to configure the crawler scope: This must be specified.
--crawl-scope=CRAWL_SCOPE
Scope of the crawler. CRAWL_SCOPE must be one of:
bucket
Directs the crawler to crawl specific buckets within the project that owns the crawler.
organization
Directs the crawler to crawl all the buckets of the projects in the organization that owns the crawler.
project
Directs the crawler to crawl all the buckets of the project that owns the crawler.

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

--buckets=[BUCKET,…]
A list of buckets to crawl. This argument should be provided if and only if --crawl-scope=BUCKET was specified.
Arguments to configure the crawler run scheduling: This must be specified.
--run-option=RUN_OPTION
Run option of the crawler. RUN_OPTION must be one of:
manual
The crawler run will have to be triggered manually.
scheduled
The crawler will run automatically on a schedule.

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

--run-schedule=RUN_SCHEDULE
Schedule for the crawler run. This argument should be provided if and only if --run-option=SCHEDULED was specified. RUN_SCHEDULE must be one of: daily, weekly.
OPTIONAL FLAGS
--bundle-specs=[PATTERN,…]
A list of bundling specifications for the crawler. Bundling specifications direct the crawler to bundle files into filesets based on the patterns provided.
--description=DESCRIPTION
Textual description of the crawler.
--display-name=DISPLAY_NAME
Human-readable display name for the crawler.
GCLOUD WIDE FLAGS
These flags are available to all commands: --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.

API REFERENCE
This command uses the datacatalog/v1alpha3 API. The full documentation for this API can be found at: https://cloud.google.com/data-catalog/docs/
EXAMPLES
Create a project-scoped crawler:
gcloud alpha data-catalog crawlers create crawler1 --run-option=MANUAL --display-name=my-crawler --crawl-scope=PROJECT

Create a bucket-scoped crawler that runs weekly:

gcloud alpha data-catalog crawlers create crawler1 --display-name=my-crawler --crawl-scope=BUCKET --buckets="gs://bucket1,gs://bucket2,gs://bucket3" --run-option=SCHEDULED --run-schedule=WEEKLY
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 may be trying to access an API with an invitation-only early access allowlist.