imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 23:08:48 +00:00
Code Activity

gcloud: Tue Mar 1 04:29:52 UTC 2022

Browse source
This commit is contained in:
Automated 2022-03-01 04:29:52 +00:00
parent aab53307a8
commit 1456dab6c7
9791 changed files with 814712 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

233
gcloud/datastream/streams/create Normal file
View file

@ -0,0 +1,233 @@
NAME
gcloud datastream streams create - create a Datastream stream
SYNOPSIS
gcloud datastream streams create (STREAM : --location=LOCATION)
--display-name=DISPLAY_NAME
(--backfill-none
| --backfill-all --mysql-excluded-objects=MYSQL_EXCLUDED_OBJECTS
| --oracle-excluded-objects=ORACLE_EXCLUDED_OBJECTS)
(--destination=DESTINATION
--gcs-destination-config=GCS_DESTINATION_CONFIG)
(--source=SOURCE (--mysql-source-config=MYSQL_SOURCE_CONFIG
| --oracle-source-config=ORACLE_SOURCE_CONFIG))
[--labels=[KEY=VALUE,...]] [--force | --validate-only]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Create a Datastream stream
EXAMPLES
To create a stream with an Oracle source and Google Cloud Storage
destination:
$ gcloud datastream streams create STREAM --location=us-central1 \
--display-name=my-stream --source=source \
--oracle-source-config=source_config.json \
--destination=destination \
--gcs-destination-config=destination_config.json --backfill-none
To create a connection profile for Mysql with a backfill all strategy that
contains some excluded objects:
$ gcloud datastream streams create STREAM --location=us-central1 \
--display-name=my-stream --source=source \
--mysql-source-config=source_config.json \
--destination=destination \
--gcs-destination-config=destination_config.json \
--backfill-all --mysql-excluded-objects=excluded_objects.json
POSITIONAL ARGUMENTS
Stream resource - The stream to create. 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 stream 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.
STREAM
ID of the stream or fully qualified identifier for the stream. To set
the stream attribute:
▸ provide the argument stream on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The Cloud location for the stream. To set the location attribute:
▸ provide the argument stream on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
REQUIRED FLAGS
--display-name=DISPLAY_NAME
Friendly name for the stream.
Exactly one of these must be specified:
--backfill-none
Do not automatically backfill any objects.
--backfill-all
Automatically backfill objects included in the stream source
configuration. Specific objects can be excluded.
At most one of these can be specified:
--mysql-excluded-objects=MYSQL_EXCLUDED_OBJECTS
MySQL data source objects to avoid backfilling.
--oracle-excluded-objects=ORACLE_EXCLUDED_OBJECTS
Oracle data source objects to avoid backfilling.
This must be specified.
Connection profile resource - Resource ID of the destination connection
profile. 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 --destination on the command line with a fully
specified name;
▸ provide the argument --project on the command line;
▸ set the property core/project. To set the location attribute:
▸ provide the argument --destination on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
This must be specified.
--destination=DESTINATION
ID of the connection_profile or fully qualified identifier for the
connection_profile. To set the connection_profile attribute:
▫ provide the argument --destination on the command line.
--gcs-destination-config=GCS_DESTINATION_CONFIG
Path to a YAML (or JSON) file containing the configuration for Google
Cloud Storage Destination Config.
The JSON file is formatted as follows:
{
"path": "some/path",
"file_rotation_mb":5,
"file_rotation_interval":"15s",
"avro_file_format": {}
}
This flag must be specified if any of the other arguments in this
group are specified.
This must be specified.
Connection profile resource - Resource ID of the source connection
profile. 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 --source on the command line with a fully
specified name;
▸ provide the argument --project on the command line;
▸ set the property core/project. To set the location attribute:
▸ provide the argument --source on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
This must be specified.
--source=SOURCE
ID of the connection_profile or fully qualified identifier for the
connection_profile. To set the connection_profile attribute:
▫ provide the argument --source on the command line.
Exactly one of these must be specified:
--mysql-source-config=MYSQL_SOURCE_CONFIG
Path to a YAML (or JSON) file containing the configuration for
Mysql Source Config.
The JSON file is formatted as follows, with snake_case field
naming:
{
"include_objects": {},
"exclude_objects": {
"mysql_databases": [
{
"database":"sample_database",
"mysql_tables": [
{
"table": "sample_table",
"mysql_columns": [
{
"column": "sample_column",
}
]
}
]
}
]
}
}
--oracle-source-config=ORACLE_SOURCE_CONFIG
Path to a YAML (or JSON) file containing the configuration for
Oracle Source Config.
The JSON file is formatted as follows, with snake_case field
naming:
{
"include_objects": {},
"exclude_objects": {
"oracle_schemas": [
{
"schema": "SAMPLE",
"oracle_tables": [
{
"table": "SAMPLE_TABLE",
"oracle_columns": [
{
"column": "COL",
}
]
}
]
}
]
}
}
OPTIONAL FLAGS
--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 these can be specified:
--force
Create the stream without validating it.
--validate-only
Only validate the stream, but do not create any resources. The
default is false.
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 variant is also available:
$ gcloud beta datastream streams create

58
gcloud/datastream/streams/delete Normal file
View file

@ -0,0 +1,58 @@
NAME
gcloud datastream streams delete - delete a Datastream stream
SYNOPSIS
gcloud datastream streams delete (STREAM : --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Deletes a stream.
EXAMPLES
To delete a stream:
$ gcloud datastream streams delete STREAM --location=us-central1
POSITIONAL ARGUMENTS
Stream resource - Stream resource - Stream 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 stream 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.
STREAM
ID of the stream or fully qualified identifier for the stream. To set
the stream attribute:
▸ provide the argument stream on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The location of the resources. To set the location attribute:
▸ provide the argument stream on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
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 datastream/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/datastream/
NOTES
This variant is also available:
$ gcloud beta datastream streams delete

59
gcloud/datastream/streams/describe Normal file
View file

@ -0,0 +1,59 @@
NAME
gcloud datastream streams describe - show details about a Datastream stream
resource
SYNOPSIS
gcloud datastream streams describe (STREAM : --location=LOCATION)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Show details about a Datastream stream resource.
EXAMPLES
To show details about a stream, run:
$ gcloud datastream streams describe my-stream --location=us-central1
POSITIONAL ARGUMENTS
Stream resource - The stream you want to get the details of. 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 stream 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.
STREAM
ID of the stream or fully qualified identifier for the stream. To set
the stream attribute:
▸ provide the argument stream on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The location of the resources. To set the location attribute:
▸ provide the argument stream on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
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 datastream/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/datastream/
NOTES
This variant is also available:
$ gcloud beta datastream streams describe

37
gcloud/datastream/streams/help Normal file
View file

@ -0,0 +1,37 @@
NAME
gcloud datastream streams - manage Datastream stream resources
SYNOPSIS
gcloud datastream streams COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Commands for managing Datastream stream resources.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
Create a Datastream stream.
delete
Delete a Datastream stream.
describe
Show details about a Datastream stream resource.
list
List Datastream stream resources.
update
Updates a Datastream stream.
NOTES
This variant is also available:
$ gcloud beta datastream streams

82
gcloud/datastream/streams/list Normal file
View file

@ -0,0 +1,82 @@
NAME
gcloud datastream streams list - list Datastream stream resources
SYNOPSIS
gcloud datastream streams list --location=LOCATION [--filter=EXPRESSION]
[--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,...]] [--uri]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
List Datastream stream resources.
EXAMPLES
To list all streams in a project and location 'us-central1', run:
$ gcloud datastream streams list --location=us-central1
REQUIRED FLAGS
Location resource - The location you want to list the streams for. 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 core/project;
◆ provide the argument --project on the command line.
This must be specified.
--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.
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 datastream/v1 API. The full documentation for this
API can be found at: https://cloud.google.com/datastream/
NOTES
This variant is also available:
$ gcloud beta datastream streams list

250
gcloud/datastream/streams/update Normal file
View file

@ -0,0 +1,250 @@
NAME
gcloud datastream streams update - updates a Datastream stream
SYNOPSIS
gcloud datastream streams update (STREAM : --location=LOCATION)
[--display-name=DISPLAY_NAME] [--state=STATE]
[--update-labels=[KEY=VALUE,...]] [--update-mask=UPDATE_MASK]
[--backfill-none
| --backfill-all --mysql-excluded-objects=MYSQL_EXCLUDED_OBJECTS
| --oracle-excluded-objects=ORACLE_EXCLUDED_OBJECTS]
[--clear-labels | --remove-labels=[KEY,...]]
[--destination=DESTINATION
: --gcs-destination-config=GCS_DESTINATION_CONFIG]
[--force | --validate-only]
[--source=SOURCE : --mysql-source-config=MYSQL_SOURCE_CONFIG
| --oracle-source-config=ORACLE_SOURCE_CONFIG] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Create a Datastream stream
EXAMPLES
To update a stream with a new source and new display name:
$ gcloud datastream streams update STREAM --location=us-central1 \
--display-name=my-stream --source=source \
--update-mask=display_name,source
To update a stream's state to RUNNING:
$ gcloud datastream streams update STREAM --location=us-central1 \
--state=RUNNING --update-mask=state
To update a stream's oracle source config:
$ gcloud datastream streams update STREAM --location=us-central1 \
--oracle-source-config=good_oracle_cp.json \
--update-mask=oracle_source_config.include_objects
POSITIONAL ARGUMENTS
Stream resource - The stream to update. 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 stream 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.
STREAM
ID of the stream or fully qualified identifier for the stream. To set
the stream attribute:
▸ provide the argument stream on the command line.
This positional must be specified if any of the other arguments in
this group are specified.
--location=LOCATION
The Cloud location for the stream. To set the location attribute:
▸ provide the argument stream on the command line with a fully
specified name;
▸ provide the argument --location on the command line.
FLAGS
--display-name=DISPLAY_NAME
Friendly name for the stream.
--state=STATE
Stream state, can be set to: "RUNNING" or "PAUSED".
--update-labels=[KEY=VALUE,...]
List of label KEY=VALUE pairs to update. If a label exists, its value
is modified. Otherwise, a new label is created.
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.
--update-mask=UPDATE_MASK
Used to specify the fields to be overwritten in the stream resource by
the update. If the update mask is used, then a field will be
overwritten only if it is in the mask. If the user does not provide a
mask then all fields will be overwritten. This is a comma-separated
list of fully qualified names of fields, written as snake_case or
camelCase. Example: "display_name, source_config.oracle_source_config".
At most one of these can be specified:
--backfill-none
Do not automatically backfill any objects.
--backfill-all
Automatically backfill objects included in the stream source
configuration. Specific objects can be excluded.
At most one of these can be specified:
--mysql-excluded-objects=MYSQL_EXCLUDED_OBJECTS
MySQL data source objects to avoid backfilling.
--oracle-excluded-objects=ORACLE_EXCLUDED_OBJECTS
Oracle data source objects to avoid backfilling.
At most one of these can be specified:
--clear-labels
Remove all labels. If --update-labels is also specified then
--clear-labels is applied first.
For example, to remove all labels:
$ gcloud datastream streams update --clear-labels
To remove all existing labels and create two new labels, foo and baz:
$ gcloud datastream streams update --clear-labels \
--update-labels foo=bar,baz=qux
--remove-labels=[KEY,...]
List of label keys to remove. If a label does not exist it is
silently ignored. If --update-labels is also specified then
--update-labels is applied first.
Connection profile resource - Resource ID of the destination connection
profile. 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 --destination on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project. To set the location attribute:
◆ provide the argument --destination on the command line with a fully
specified name;
◆ provide the argument --location on the command line.
--destination=DESTINATION
ID of the connection_profile or fully qualified identifier for the
connection_profile. To set the connection_profile attribute:
▸ provide the argument --destination on the command line.
--gcs-destination-config=GCS_DESTINATION_CONFIG
Path to a YAML (or JSON) file containing the configuration for Google
Cloud Storage Destination Config.
The JSON file is formatted as follows:
{
"path": "some/path",
"file_rotation_mb":5,
"file_rotation_interval":"15s",
"avro_file_format": {}
}
At most one of these can be specified:
--force
Update the stream without validating it.
--validate-only
Only validate the stream, but do not update any resources. The
default is false.
Connection profile resource - Resource ID of the source connection
profile. 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 --source on the command line with a fully
specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project. To set the location attribute:
◆ provide the argument --source on the command line with a fully
specified name;
◆ provide the argument --location on the command line.
--source=SOURCE
ID of the connection_profile or fully qualified identifier for the
connection_profile. To set the connection_profile attribute:
▸ provide the argument --source on the command line.
At most one of these can be specified:
--mysql-source-config=MYSQL_SOURCE_CONFIG
Path to a YAML (or JSON) file containing the configuration for Mysql
Source Config.
The JSON file is formatted as follows, with snake_case field naming:
{
"include_objects": {},
"exclude_objects": {
"mysql_databases": [
{
"database":"sample_database",
"mysql_tables": [
{
"table": "sample_table",
"mysql_columns": [
{
"column": "sample_column",
}
]
}
]
}
]
}
}
--oracle-source-config=ORACLE_SOURCE_CONFIG
Path to a YAML (or JSON) file containing the configuration for Oracle
Source Config.
The JSON file is formatted as follows, with snake_case field naming:
{
"include_objects": {},
"exclude_objects": {
"oracle_schemas": [
{
"schema": "SAMPLE",
"oracle_tables": [
{
"table": "SAMPLE_TABLE",
"oracle_columns": [
{
"column": "COL",
}
]
}
]
}
]
}
}
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 variant is also available:
$ gcloud beta datastream streams update