1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 14:56:05 +00:00

gcloud: Wed Nov 1 10:29:29 UTC 2023

This commit is contained in:
Automated 2023-11-01 10:29:29 +00:00
parent ecf00beb5e
commit f2c5d1d45f
371 changed files with 9433 additions and 9676 deletions

View file

@ -1,159 +0,0 @@
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)
[--description=DESCRIPTION] [--display-name=DISPLAY_NAME]
[--labels=[KEY=VALUE,...]] [--async | --validate-only]
[--data-profile-spec-file=DATA_PROFILE_SPEC_FILE
| --data-quality-spec-file=DATA_QUALITY_SPEC_FILE]
[--field=FIELD --on-demand=ON_DEMAND --schedule=SCHEDULE]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) (DEPRECATED) Create a Dataplex Datascan.
This command is deprecated. Please use gcloud alpha dataplex datascans
create data-profile instead to create a data profile scan and use gcloud
alpha dataplex datascans create data-quality to create a data quality scan.
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
--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.
Additional configuration arguments for the scan.
At most one of these can be specified:
DataProfileScan related setting.
--data-profile-spec-file=DATA_PROFILE_SPEC_FILE
path to the JSON file containing the Data Profile Spec for the Data
Profile 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
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
--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.

View file

@ -1,74 +0,0 @@
NAME
gcloud alpha dataplex datascan delete - delete a Dataplex Datascan resource
SYNOPSIS
gcloud alpha dataplex datascan delete (DATASCAN : --location=LOCATION)
[--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud alpha
dataplex datascans instead.
Delete a Dataplex Datascan resource.
EXAMPLES
To delete a Dataplex Datascan test-datascan in location us-central1, run:
$ gcloud alpha dataplex datascan 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.

View file

@ -1,71 +0,0 @@
NAME
gcloud alpha dataplex datascan describe - describe a Dataplex lake resource
SYNOPSIS
gcloud alpha dataplex datascan describe (DATASCAN : --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud alpha
dataplex datascans instead.
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 datascan 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.
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.

View file

@ -1,47 +0,0 @@
NAME
gcloud alpha dataplex datascan - manage Dataplex Datascan
SYNOPSIS
gcloud alpha dataplex datascan GROUP | COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) (DEPRECATED) Manage Dataplex Datascan.
This command is deprecated. Please use gcloud alpha dataplex datascans
instead.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
GROUPS
GROUP is one of the following:
jobs
(ALPHA) (DEPRECATED) Manage Dataplex Datascan Jobs services.
COMMANDS
COMMAND is one of the following:
create
(ALPHA) (DEPRECATED) Create a Dataplex Datascan.
delete
(ALPHA) (DEPRECATED) Delete a Dataplex Datascan resource.
describe
(ALPHA) (DEPRECATED) Describe a Dataplex lake resource.
list
(ALPHA) (DEPRECATED) List Dataplex Datascan resources under a project.
run
(ALPHA) (DEPRECATED) Run 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.

View file

@ -1,99 +0,0 @@
NAME
gcloud alpha dataplex datascan jobs describe - describe a Dataplex job
running a particular datascan
SYNOPSIS
gcloud alpha dataplex datascan jobs describe
(JOB : --datascan=DATASCAN --location=LOCATION) [--view=VIEW]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud alpha
dataplex datascans jobs instead.
Describe a Dataplex job running a particular datascan.
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 datascan 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 datascan 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
There are two possible views: 'basic' and 'full'. 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.

View file

@ -1,34 +0,0 @@
NAME
gcloud alpha dataplex datascan jobs - manage Dataplex Datascan Jobs
services
SYNOPSIS
gcloud alpha dataplex datascan jobs COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) (DEPRECATED) Manage Dataplex Datascan Jobs services.
This command is deprecated. Please use gcloud alpha dataplex datascans jobs
instead.
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) (DEPRECATED) Describe a Dataplex job running a particular
datascan.
list
(ALPHA) (DEPRECATED) 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.

View file

@ -1,104 +0,0 @@
NAME
gcloud alpha dataplex datascan jobs list - list job runs of a Dataplex
datascan resource
SYNOPSIS
gcloud alpha dataplex datascan jobs list
(--datascan=DATASCAN : --location=LOCATION) [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud alpha
dataplex datascans jobs instead.
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 datascan 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.

View file

@ -1,96 +0,0 @@
NAME
gcloud alpha dataplex datascan list - list Dataplex Datascan resources
under a project
SYNOPSIS
gcloud alpha dataplex datascan list [--location=LOCATION]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud alpha
dataplex datascans instead.
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 datascan list --project=test-project \
--location=us-central1
To list all Dataplex Datascan in all locations, run:
$ gcloud alpha dataplex datascan 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.

View file

@ -1,69 +0,0 @@
NAME
gcloud alpha dataplex datascan run - run a Dataplex DataScan resource
SYNOPSIS
gcloud alpha dataplex datascan run (DATASCAN : --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) (DEPRECATED) This command is deprecated. Please use gcloud alpha
dataplex datascans instead.
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 datascan 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.

View file

@ -27,9 +27,6 @@ GROUPS
data-taxonomies
(ALPHA) Manage Dataplex Data Taxonomies.
datascan
(ALPHA) (DEPRECATED) Manage Dataplex Datascan.
datascans
(ALPHA) Manage Dataplex Datascan.