1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-19 07:15:23 +00:00

gcloud: Wed Aug 2 11:22:33 UTC 2023

This commit is contained in:
Automated 2023-08-02 11:22:33 +00:00
parent 4558a00e48
commit 678b9afba9
240 changed files with 7837 additions and 521 deletions

View file

@ -0,0 +1,172 @@
NAME
gcloud alpha dataplex datascans create data-profile - create a Dataplex
data profile scan job
SYNOPSIS
gcloud alpha dataplex datascans create data-profile
(DATASCAN : --location=LOCATION)
(--data-source-entity=DATA_SOURCE_ENTITY
| --data-source-resource=DATA_SOURCE_RESOURCE)
[--description=DESCRIPTION] [--display-name=DISPLAY_NAME]
[--labels=[KEY=VALUE,...]] [--async | --validate-only]
[--data-profile-spec-file=DATA_PROFILE_SPEC_FILE
| --exclude-field-names=EXCLUDE_FIELD_NAMES
--include-field-names=INCLUDE_FIELD_NAMES
--row-filter=ROW_FILTER --sampling-percent=SAMPLING_PERCENT]
[--incremental-field=INCREMENTAL_FIELD --on-demand=ON_DEMAND
| --schedule=SCHEDULE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Represents a user-visible job which provides the insights for the
related data source about the structure, content and relationships (such as
null percent, cardinality, min/max/mean, etc).
EXAMPLES
To create a data profile scan data-profile-datascan in project test-project
located in us-central1, run:
$ gcloud alpha dataplex datascans create data-profile data-profile \
data-profile-datascan --project=test-project \
--location=us-central1
POSITIONAL ARGUMENTS
Datascan resource - Arguments and flags that define the Dataplex datascan
you want to create a data profile scan 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
Data source for the data profile scan.
Exactly one of these must be specified:
--data-source-entity=DATA_SOURCE_ENTITY
Dataplex entity that contains the data for the data profile scan, of
the form:
projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
--data-source-resource=DATA_SOURCE_RESOURCE
Fully-qualified service resource name of the cloud resource that
contains the data for the data profile scan, of the form:
//bigquery.googleapis.com/projects/{project_number}/datasets/{dataset_id}/tables/{table_id}.
OPTIONAL FLAGS
--description=DESCRIPTION
Description of the data profile scan.
--display-name=DISPLAY_NAME
Display name of the data profile scan.
--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.
Data spec for the data profile scan.
At most one of these can be specified:
--data-profile-spec-file=DATA_PROFILE_SPEC_FILE
path to the JSON/YAML file containing the spec for the data profile
scan. The JSON representation reference:
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataProfileSpec
Command line spec arguments for the data profile scan.
--exclude-field-names=EXCLUDE_FIELD_NAMES
Names of the fields to exclude from data profile. If specified, the
respective fields will be excluded from data profile, regardless of
the fields specified in the --include-field-names flag.
--include-field-names=INCLUDE_FIELD_NAMES
Names of the fields to include in data profile. If not specified,
all fields at the time of profile scan job execution are included.
The fields listed in the --exclude-field-names flag are excluded.
--row-filter=ROW_FILTER
A filter applied to all rows in a single data profile scan job.
--sampling-percent=SAMPLING_PERCENT
The percentage of the records to be selected from the dataset for
data profile scan.
Data profile scan execution settings.
--incremental-field=INCREMENTAL_FIELD
Field that contains values that monotonically increase over time
(e.g. timestamp).
Data profile scan scheduling and trigger settings.
At most one of these can be specified:
--on-demand=ON_DEMAND
If set, the scan runs one-time shortly after data profile scan
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. This variant is also available:
$ gcloud dataplex datascans create data-profile

View file

@ -0,0 +1,147 @@
NAME
gcloud alpha dataplex datascans create data-quality - create a Dataplex
data quality scan job
SYNOPSIS
gcloud alpha dataplex datascans create data-quality
(DATASCAN : --location=LOCATION)
--data-quality-spec-file=DATA_QUALITY_SPEC_FILE
(--data-source-entity=DATA_SOURCE_ENTITY
| --data-source-resource=DATA_SOURCE_RESOURCE)
[--description=DESCRIPTION] [--display-name=DISPLAY_NAME]
[--labels=[KEY=VALUE,...]] [--async | --validate-only]
[--incremental-field=INCREMENTAL_FIELD --on-demand=ON_DEMAND
| --schedule=SCHEDULE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Represents a user-visible job which provides the insights for the
related data source and generates queries based on the rules and runs
against the data to get data quality check results.
EXAMPLES
To create a data quality scan data-quality-datascan in project test-project
located in us-central1 with data spec file data-quality-spec.json, run:
$ gcloud alpha dataplex datascans create data-quality data-quality \
data-quality-datascan --project=test-project \
--location=us-central1 \
--data-quality-spec-file="data-quality-spec.json"
POSITIONAL ARGUMENTS
Datascan resource - Arguments and flags that define the Dataplex datascan
you want to create a data quality scan 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
--data-quality-spec-file=DATA_QUALITY_SPEC_FILE
path to the JSON/YAML file containing the spec for the data quality
scan. The json representation reference:
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualitySpec
Data source for the data quality scan.
Exactly one of these must be specified:
--data-source-entity=DATA_SOURCE_ENTITY
Dataplex entity that contains the data for the data quality scan, of
the form:
projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.
--data-source-resource=DATA_SOURCE_RESOURCE
Fully-qualified service resource name of the cloud resource that
contains the data for the data quality scan, of the form:
//bigquery.googleapis.com/projects/{project_number}/datasets/{dataset_id}/tables/{table_id}.
OPTIONAL FLAGS
--description=DESCRIPTION
Description of the data quality scan.
--display-name=DISPLAY_NAME
Display name of the data quality scan.
--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.
Data quality scan execution settings.
--incremental-field=INCREMENTAL_FIELD
Field that contains values that monotonically increase over time
(e.g. timestamp).
Data quality scan scheduling and trigger settings
At most one of these can be specified:
--on-demand=ON_DEMAND
If set, the scan runs one-time shortly after data quality scan
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. This variant is also available:
$ gcloud dataplex datascans create data-quality

View file

@ -0,0 +1,31 @@
NAME
gcloud alpha dataplex datascans create - manage Dataplex Datascans creation
SYNOPSIS
gcloud alpha dataplex datascans create COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Manage Dataplex Datascans creation.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
data-profile
(ALPHA) Create a Dataplex data profile scan job.
data-quality
(ALPHA) Create a Dataplex data quality scan job.
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. This variant is also available:
$ gcloud dataplex datascans create

View file

@ -0,0 +1,74 @@
NAME
gcloud alpha dataplex datascans delete - delete a Dataplex Datascan
resource
SYNOPSIS
gcloud alpha dataplex datascans delete (DATASCAN : --location=LOCATION)
[--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Delete a Dataplex Datascan resource.
EXAMPLES
To delete a Dataplex Datascan test-datascan in location us-central1, run:
$ gcloud alpha dataplex datascans delete test-datascan \
--location=us-central1
POSITIONAL ARGUMENTS
Datascan resource - Arguments and flags that define the Dataplex Datascan
you want to delete. 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;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
DATASCAN
ID of the datascan or fully qualified identifier for the datascan.
To set the datascan 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
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.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
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.
API REFERENCE
This command uses the dataplex/v1 API. The full documentation for this API
can be found at: https://cloud.google.com/dataplex/docs
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. This variant is also available:
$ gcloud dataplex datascans delete

View file

@ -0,0 +1,82 @@
NAME
gcloud alpha dataplex datascans describe - describe a Dataplex datascan
resource
SYNOPSIS
gcloud alpha dataplex datascans describe (DATASCAN : --location=LOCATION)
[--view=VIEW] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Displays all details of a Dataplex Datascan resource given a valid
Datascan ID.
EXAMPLES
To describe a Dataplex Datascan test-datascan in project test-project
location us-central1 , run:
$ gcloud alpha dataplex datascans describe test-datascan \
--project=test-project --location=us-central1
POSITIONAL ARGUMENTS
Datascan resource - Arguments and flags that define the Dataplex Datascan
you want to retrieve. 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;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
DATASCAN
ID of the datascan or fully qualified identifier for the datascan.
To set the datascan 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
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.
FLAGS
--view=VIEW
Displays spec data based on the argument value. The default view is
'basic'. VIEW must be one of:
basic
Does not include spec data in response.
full
Includes spec data in response.
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.
API REFERENCE
This command uses the dataplex/v1 API. The full documentation for this API
can be found at: https://cloud.google.com/dataplex/docs
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. This variant is also available:
$ gcloud dataplex datascans describe

View file

@ -0,0 +1,101 @@
NAME
gcloud alpha dataplex datascans get-iam-policy - get the IAM policy for a
Dataplex datascan resource
SYNOPSIS
gcloud alpha dataplex datascans get-iam-policy
(DATASCAN : --location=LOCATION) [--filter=EXPRESSION] [--limit=LIMIT]
[--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Displays the IAM policy associated with a Dataplex datascan
resource. If formatted as JSON, the output can be edited and used as a
policy file for set-iam-policy. The output includes an "etag" field
identifying the version emitted and allowing detection of concurrent policy
updates.
EXAMPLES
To print the IAM policy for Dataplex datascan test-datascan in location
us-central1, run:
$ gcloud alpha dataplex datascans get-iam-policy test-datascan \
--location=us-central1
POSITIONAL ARGUMENTS
Datascan resource - Arguments and flags that define the Dataplex datascan
IAM policy you want to retrieve. 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;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
DATASCAN
ID of the datascan or fully qualified identifier for the datascan.
To set the datascan 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
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.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
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.
API REFERENCE
This command uses the dataplex/v1 API. The full documentation for this API
can be found at: https://cloud.google.com/dataplex/docs
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. This variant is also available:
$ gcloud dataplex datascans get-iam-policy

View file

@ -0,0 +1,56 @@
NAME
gcloud alpha dataplex datascans - manage Dataplex Datascan
SYNOPSIS
gcloud alpha dataplex datascans GROUP | COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Manage Dataplex Datascan.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
create
(ALPHA) Manage Dataplex Datascans creation.
jobs
(ALPHA) Manage Dataplex Datascan Jobs service.
update
(ALPHA) Manage Dataplex Datascans updation.
COMMANDS
COMMAND is one of the following:
delete
(ALPHA) Delete a Dataplex Datascan resource.
describe
(ALPHA) Describe a Dataplex datascan resource.
get-iam-policy
(ALPHA) Get the IAM policy for a Dataplex datascan resource.
list
(ALPHA) List Dataplex Datascan resources under a project.
run
(ALPHA) Run a Dataplex DataScan resource.
set-iam-policy
(ALPHA) Set the IAM policy to a Dataplex datascan as defined in a JSON
or YAML file.
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. This variant is also available:
$ gcloud dataplex datascans

View file

@ -0,0 +1,98 @@
NAME
gcloud alpha dataplex datascans jobs describe - describe a Dataplex
datascan job
SYNOPSIS
gcloud alpha dataplex datascans jobs describe
(JOB : --datascan=DATASCAN --location=LOCATION) [--view=VIEW]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) 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:
$ gcloud alpha dataplex datascans jobs describe 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:
$ gcloud alpha dataplex datascans jobs describe test-job \
--location=us-central1 --datascan=test-datascan --view=FULL
POSITIONAL ARGUMENTS
Job resource - Arguments and flags that define the Dataplex Job running a
particular Datascan you want to retrieve. 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 job 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.
JOB
ID of the job or fully qualified identifier for the job.
To set the job attribute:
▸ provide the argument job on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--datascan=DATASCAN
Datascan ID of the Dataplex datascan resource.
To set the datascan attribute:
▸ provide the argument job on the command line with a fully
specified name;
▸ provide the argument --datascan on the command line.
--location=LOCATION
Location of the Dataplex resource.
To set the location attribute:
▸ provide the argument job on the command line with a fully
specified name;
▸ provide the argument --location on the command line;
▸ set the property dataplex/location.
FLAGS
--view=VIEW
Displays spec and result data based on the argument value. The default
view is 'basic'. VIEW must be one of:
basic
Does not include spec and result data in response.
full
Includes spec and result data in response.
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.
API REFERENCE
This command uses the dataplex/v1 API. The full documentation for this API
can be found at: https://cloud.google.com/dataplex/docs
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. This variant is also available:
$ gcloud dataplex datascans jobs describe

View file

@ -0,0 +1,32 @@
NAME
gcloud alpha dataplex datascans jobs - manage Dataplex Datascan Jobs
service
SYNOPSIS
gcloud alpha dataplex datascans jobs COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Manage Dataplex Datascan Jobs service.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
describe
(ALPHA) Describe a Dataplex datascan job.
list
(ALPHA) List job runs of a Dataplex datascan resource.
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. This variant is also available:
$ gcloud dataplex datascans jobs

View file

@ -0,0 +1,104 @@
NAME
gcloud alpha dataplex datascans jobs list - list job runs of a Dataplex
datascan resource
SYNOPSIS
gcloud alpha dataplex datascans jobs list
(--datascan=DATASCAN : --location=LOCATION) [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List Jobs runs of a Datascan under a specific project, location and
task.
EXAMPLES
To list all the Dataplex job runs for a datascan test-datascan in location
us-central1, run:
gcloud alpha dataplex datascans jobs list --location=us-central1 --datascan=test-datascan
REQUIRED FLAGS
Datascan resource - Arguments and flags that define the Dataplex Datascan
to list the Jobs running the Datascan. 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;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
--datascan=DATASCAN
ID of the datascan or fully qualified identifier for the datascan.
To set the datascan attribute:
▸ provide the argument --datascan on the command line.
This flag argument must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
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.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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.
API REFERENCE
This command uses the dataplex/v1 API. The full documentation for this API
can be found at: https://cloud.google.com/dataplex/docs
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. This variant is also available:
$ gcloud dataplex datascans jobs list

View file

@ -0,0 +1,96 @@
NAME
gcloud alpha dataplex datascans list - list Dataplex Datascan resources
under a project
SYNOPSIS
gcloud alpha dataplex datascans list [--location=LOCATION]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) List all Dataplex Datascan resource under a specific project and
location.
EXAMPLES
To list all Dataplex Datascan resources in project=test-project in location
us-central, run:
$ gcloud alpha dataplex datascans list --project=test-project \
--location=us-central1
To list all Dataplex Datascan in all locations, run:
$ gcloud alpha dataplex datascans list --project=test-project \
--location=-
FLAGS
Location resource - Arguments and flags that define the Dataplex Datascan
you want to list. 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 --location on the command line with a fully
specified name;
◆ set the property dataplex/location with a fully specified name;
◆ set the property core/project;
◆ provide the argument --project on the command line.
--location=LOCATION
ID of the location or fully qualified identifier for the location.
To set the location attribute:
▸ provide the argument --location on the command line;
▸ set the property dataplex/location.
LIST COMMAND FLAGS
--filter=EXPRESSION
Apply a Boolean filter EXPRESSION to each resource item to be listed.
If the expression evaluates True, then that item is listed. For more
details and examples of filter expressions, run $ gcloud topic filters.
This flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--limit=LIMIT
Maximum number of resources to list. The default is unlimited. This
flag interacts with other flags that are applied in this order:
--flatten, --sort-by, --filter, --limit.
--page-size=PAGE_SIZE
Some services group resource list output into pages. This flag
specifies the maximum number of resources per page. The default is
determined by the service if it supports paging, otherwise it is
unlimited (no paging). Paging may be applied before or after --filter
and --limit depending on the service.
--sort-by=[FIELD,...]
Comma-separated list of resource field key names to sort by. The
default order is ascending. Prefix a field with ``~'' for descending
order on that field. This flag interacts with other flags that are
applied in this order: --flatten, --sort-by, --filter, --limit.
--uri
Print a list of resource URIs instead of the default output, and change
the command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs
alongside other keys instead, use the uri() transform.
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.
API REFERENCE
This command uses the dataplex/v1 API. The full documentation for this API
can be found at: https://cloud.google.com/dataplex/docs
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. This variant is also available:
$ gcloud dataplex datascans list

View file

@ -0,0 +1,68 @@
NAME
gcloud alpha dataplex datascans run - run a Dataplex DataScan resource
SYNOPSIS
gcloud alpha dataplex datascans run (DATASCAN : --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Run a Dataplex Datascan resource given a valid Datascan ID.
EXAMPLES
To run a Dataplex Datascan test-datascan in location us-central1 , run:
$ gcloud alpha dataplex datascans run test-datascan \
--location=us-central1
POSITIONAL ARGUMENTS
Datascan resource - Arguments and flags that define the Dataplex Datascan
you want to run. 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;
◆ set the property core/project;
◆ provide the argument --project on the command line.
This must be specified.
DATASCAN
ID of the datascan or fully qualified identifier for the datascan.
To set the datascan 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
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.
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.
API REFERENCE
This command uses the dataplex/v1 API. The full documentation for this API
can be found at: https://cloud.google.com/dataplex/docs
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. This variant is also available:
$ gcloud dataplex datascans run

View file

@ -0,0 +1,75 @@
NAME
gcloud alpha dataplex datascans set-iam-policy - set the IAM policy to a
Dataplex datascan as defined in a JSON or YAML file
SYNOPSIS
gcloud alpha dataplex datascans set-iam-policy
(DATASCAN : --location=LOCATION) POLICY_FILE [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) See https://cloud.google.com/iam/docs/managing-policies for details
of the policy file format and contents.
EXAMPLES
The following command will read an IAM policy defined in a JSON file
policy.son and set it for the Dataplex datascan test-datascan defined in
location us-central1:
$ gcloud alpha dataplex datascans set-iam-policy \
--location=us-central1 test-datascan policy.json
POSITIONAL ARGUMENTS
Datascan resource - Arguments and flags that define the Dataplex datascan
you want to set IAM policy binding to. 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.
POLICY_FILE
Path to a local JSON or YAML formatted file containing a valid policy.
The output of the get-iam-policy command is a valid file, as is any
JSON or YAML file conforming to the structure of a Policy
(https://cloud.google.com/iam/reference/rest/v1/Policy).
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. This variant is also available:
$ gcloud dataplex datascans set-iam-policy

View file

@ -0,0 +1,150 @@
NAME
gcloud alpha dataplex datascans update data-profile - update a Dataplex
data profile scan job
SYNOPSIS
gcloud alpha dataplex datascans update data-profile
(DATASCAN : --location=LOCATION) [--description=DESCRIPTION]
[--display-name=DISPLAY_NAME] [--labels=[KEY=VALUE,...]]
[--async | --validate-only]
[--data-profile-spec-file=DATA_PROFILE_SPEC_FILE
| --exclude-field-names=EXCLUDE_FIELD_NAMES
--include-field-names=INCLUDE_FIELD_NAMES
--row-filter=ROW_FILTER --sampling-percent=SAMPLING_PERCENT]
[--on-demand=ON_DEMAND | --schedule=SCHEDULE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Represents a user-visible job which provides the insights for the
related data source about the structure, content and relationships (such as
null percent, cardinality, min/max/mean, etc).
EXAMPLES
To update description of a data profile scan data-profile-datascan in
project test-project located in us-central1, run:
$ gcloud alpha dataplex datascans update data-profile data-profile \
data-profile-datascan --project=test-project \
--location=us-central1 --description="Description is updated."
POSITIONAL ARGUMENTS
Datascan resource - Arguments and flags that define the Dataplex datascan
you want to update a data profile scan 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.
FLAGS
--description=DESCRIPTION
Description of the data profile scan
--display-name=DISPLAY_NAME
Display name of the data profile scan
--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 update action, but don't actually perform it.
Data spec for the data profile scan.
At most one of these can be specified:
--data-profile-spec-file=DATA_PROFILE_SPEC_FILE
path to the JSON/YAML file containing the spec for the data profile
scan. The JSON representation reference:
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataProfileSpec
Command line spec arguments for the data profile scan.
--exclude-field-names=EXCLUDE_FIELD_NAMES
Names of the fields to exclude from data profile. If specified, the
respective fields will be excluded from data profile, regardless of
the fields specified in the --include-field-names flag.
--include-field-names=INCLUDE_FIELD_NAMES
Names of the fields to include in data profile. If not specified,
all fields at the time of profile scan job execution are included.
The fields listed in the --exclude-field-names flag are excluded.
--row-filter=ROW_FILTER
A filter applied to all rows in a single data profile scan job.
--sampling-percent=SAMPLING_PERCENT
The percentage of the records to be selected from the dataset for
data profile scan.
Data profile scan execution settings.
Data profile scan scheduling and trigger settings
At most one of these can be specified:
--on-demand=ON_DEMAND
If set, the scan runs one-time shortly after data profile scan
updation.
--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. This variant is also available:
$ gcloud dataplex datascans update data-profile

View file

@ -0,0 +1,124 @@
NAME
gcloud alpha dataplex datascans update data-quality - update a Dataplex
data quality scan job
SYNOPSIS
gcloud alpha dataplex datascans update data-quality
(DATASCAN : --location=LOCATION)
[--data-quality-spec-file=DATA_QUALITY_SPEC_FILE]
[--description=DESCRIPTION] [--display-name=DISPLAY_NAME]
[--labels=[KEY=VALUE,...]] [--async | --validate-only]
[--on-demand=ON_DEMAND | --schedule=SCHEDULE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Represents a user-visible job which provides the insights for the
related data source and generates queries based on the rules and runs
against the data to get data quality check results.
EXAMPLES
To update description of a data quality scan data-quality-datascan in
project test-project located in us-central1, run:
$ gcloud alpha dataplex datascans update data-quality data-quality \
data-quality-datascan --project=test-project \
--location=us-central1 --description="Description is updated."
POSITIONAL ARGUMENTS
Datascan resource - Arguments and flags that define the Dataplex datascan
you want to update a data quality scan 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.
FLAGS
--data-quality-spec-file=DATA_QUALITY_SPEC_FILE
path to the JSON/YAML file containing the spec for the data quality
scan. The json representation reference:
https://cloud.google.com/dataplex/docs/reference/rest/v1/DataQualitySpec
--description=DESCRIPTION
Description of the data quality scan
--display-name=DISPLAY_NAME
Display name of the data quality scan
--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 update action, but don't actually perform it.
Data quality scan execution settings.
Data quality scan scheduling and trigger settings
At most one of these can be specified:
--on-demand=ON_DEMAND
If set, the scan runs one-time shortly after data quality scan
updation.
--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. This variant is also available:
$ gcloud dataplex datascans update data-quality

View file

@ -0,0 +1,31 @@
NAME
gcloud alpha dataplex datascans update - manage Dataplex Datascans updation
SYNOPSIS
gcloud alpha dataplex datascans update COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Manage Dataplex Datascans updation.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
data-profile
(ALPHA) Update a Dataplex data profile scan job.
data-quality
(ALPHA) Update a Dataplex data quality scan job.
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. This variant is also available:
$ gcloud dataplex datascans update