gcloud alpha data-catalog crawlers update - update a Data Catalog crawler
gcloud alpha data-catalog crawlers update CRAWLER [--description=DESCRIPTION] [--display-name=DISPLAY_NAME] [--add-bundle-specs=[PATTERN,...] --clear-bundle-specs | --remove-bundle-specs=[PATTERN,...]] [--crawl-scope=CRAWL_SCOPE --add-buckets=[BUCKET,...] --clear-buckets | --remove-buckets=[BUCKET,...]] [--run-option=RUN_OPTION --run-schedule=RUN_SCHEDULE] [GCLOUD_WIDE_FLAG ...]
(ALPHA) Update a Data Catalog crawler.
Update the display name of a crawler:
$ gcloud alpha data-catalog crawlers update crawler1 \ --display-name="my-crawler"
Add buckets to a BUCKET-scoped crawler:
$ gcloud alpha data-catalog crawlers update crawler1 \ --add-buckets=bucket1,bucket2
Remove buckets from a BUCKET-scoped crawler:
$ gcloud alpha data-catalog crawlers update crawler1 \ --remove-buckets=bucket1,bucket2
Overwrite buckets in a BUCKET-scoped crawler with bucket1, bucket2:
$ gcloud alpha data-catalog crawlers update crawler1 \ --clear-buckets --add-buckets=bucker1,bucket2
Change the schedule of a manual crawler to run daily:
$ gcloud alpha data-catalog crawlers update crawler1 \ --run-option=SCHEDULED --run-schedule=DAILY
- Crawler resource - The crawler to update. 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. To set the crawler attribute:
provide the argument crawler on the command line.
- --description=DESCRIPTION
Textual description of the crawler.
- --display-name=DISPLAY_NAME
Human-readable display name for the crawler.
- Update bundling specifications. Bundling specifications direct the crawler to
bundle files into filesets based on the patterns provided:
- --add-bundle-specs=[PATTERN,...]
A list of bundling specifications to add to the existing ones.
- At most one of these can be specified:
- --clear-bundle-specs
If specified, clear the existing list of bundling specifications.
- --remove-bundle-specs=[PATTERN,...]
A list of bundling specifications to remove from the existing ones.
- Arguments to configure the crawler scope:
- --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.
- Update buckets to crawl. These arguments can be provided only if the crawler
will be bucket-scoped after updating.
- --add-buckets=[BUCKET,...]
List of buckets to add to the crawl scope.
- At most one of these can be specified:
- --clear-buckets
If specified, clear the existing list of buckets in the crawl scope.
- --remove-buckets=[BUCKET,...]
List of buckets to remove from the crawl scope.
- Arguments to configure the crawler run scheduling:
- --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.
- --run-schedule=RUN_SCHEDULE
Schedule for the crawler run. This argument can be provided only if the crawler run option will be scheduled after updating. RUN_SCHEDULE must be one of: daily, weekly.
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.
This command uses the datacatalog/v1alpha3 API. The full documentation for this API can be found at: https://cloud.google.com/data-catalog/docs/
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.