imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-08 02:25:19 +00:00
Code Activity

gcloud: Wed Mar 6 09:53:10 UTC 2024

Browse source
This commit is contained in:
Automated 2024-03-06 09:53:10 +00:00
parent 37dd57701a
commit 7f632e0c5d
115 changed files with 5800 additions and 308 deletions
Download patch file Download diff file Expand all files Collapse all files

3
gcloud/bigtable/help
View file

@ -33,6 +33,9 @@ GROUPS
operations
Manage Cloud Bigtable operations.
tables
Query Cloud Bigtable tables.
NOTES
These variants are also available:

145
gcloud/bigtable/tables/add-iam-policy-binding Normal file
View file

@ -0,0 +1,145 @@
NAME
gcloud bigtable tables add-iam-policy-binding - add an IAM policy binding
to a Cloud Bigtable table
SYNOPSIS
gcloud bigtable tables add-iam-policy-binding (TABLE : --instance=INSTANCE)
--member=PRINCIPAL --role=ROLE
[--condition=[KEY=VALUE,...]
| --condition-from-file=CONDITION_FROM_FILE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Add an IAM policy binding to a Cloud Bigtable table. One binding consists
of a member, a role, and an optional condition.
EXAMPLES
To add an IAM policy binding for the role of 'roles/editor' for the user
'test-user@gmail.com' with table 'my-table' in instance 'my-instance', run:
$ gcloud bigtable tables add-iam-policy-binding my-table \
--instance='my-instance' --member='user:test-user@gmail.com' \
--role='roles/editor'
To add an IAM policy binding which expires at the end of the year 2019 for
the role of 'roles/bigtable.admin' and the user 'test-user@gmail.com' with
table 'my-table' in instance 'my-instance', run:
$ gcloud bigtable tables add-iam-policy-binding my-table \
--instance='my-instance' --member='user:test-user@gmail.com' \
--role='roles/bigtable.admin' \
--condition='expression=request.time <
timestamp("2020-01-01T00:00:00Z"),title=expires_end_of_2019,descrip\
tion=Expires at midnight on 2019-12-31'
See https://cloud.google.com/iam/docs/managing-policies for details of
policy role and member types.
POSITIONAL ARGUMENTS
Table resource - Cloud Bigtable table to add the 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 table 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.
TABLE
ID of the table or fully qualified identifier for the table.
To set the table attribute:
▸ provide the argument table on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--instance=INSTANCE
Name of the Cloud Bigtable instance.
To set the instance attribute:
▸ provide the argument table on the command line with a fully
specified name;
▸ provide the argument --instance on the command line.
REQUIRED FLAGS
--member=PRINCIPAL
The principal to add the binding for. Should be of the form
user|group|serviceAccount:email or domain:domain.
Examples: user:test-user@gmail.com, group:admins@example.com,
serviceAccount:test123@example.domain.com, or
domain:example.domain.com.
Some resources also accept the following special values:
◆ allUsers - Special identifier that represents anyone who is on the
internet, with or without a Google account.
◆ allAuthenticatedUsers - Special identifier that represents anyone
who is authenticated with a Google account or a service account.
--role=ROLE
Role name to assign to the principal. The role name is the complete
path of a predefined role, such as roles/logging.viewer, or the role ID
for a custom role, such as
organizations/{ORGANIZATION_ID}/roles/logging.viewer.
OPTIONAL FLAGS
At most one of these can be specified:
--condition=[KEY=VALUE,...]
A condition to include in the binding. When the condition is
explicitly specified as None (--condition=None), a binding without a
condition is added. When the condition is specified and is not None,
--role cannot be a basic role. Basic roles are roles/editor,
roles/owner, and roles/viewer. For more on conditions, refer to the
conditions overview guide:
https://cloud.google.com/iam/docs/conditions-overview
When using the --condition flag, include the following key-value
pairs:
expression
(Required) Condition expression that evaluates to True or False.
This uses a subset of Common Expression Language syntax.
If the condition expression includes a comma, use a different
delimiter to separate the key-value pairs. Specify the delimiter
before listing the key-value pairs. For example, to specify a
colon (:) as the delimiter, do the following:
--condition=^:^title=TITLE:expression=EXPRESSION. For more
information, see
https://cloud.google.com/sdk/gcloud/reference/topic/escaping.
title
(Required) A short string describing the purpose of the
expression.
description
(Optional) Additional description for the expression.
--condition-from-file=CONDITION_FROM_FILE
Path to a local JSON or YAML file that defines the condition. To see
available fields, see the help for --condition.
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 bigtableadmin/v2 API. The full documentation for this
API can be found at: https://cloud.google.com/bigtable/
NOTES
These variants are also available:
$ gcloud alpha bigtable tables add-iam-policy-binding
$ gcloud beta bigtable tables add-iam-policy-binding

126
gcloud/bigtable/tables/create Normal file
View file

@ -0,0 +1,126 @@
NAME
gcloud bigtable tables create - create a new Cloud Bigtable table
SYNOPSIS
gcloud bigtable tables create (TABLE : --instance=INSTANCE)
--column-families=[COLUMN_FAMILIES,...]
[--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD]
[--deletion-protection] [--splits=[SPLITS,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Create a new Cloud Bigtable table.
EXAMPLES
To create a table my-table in instance my-instance with a column family
my-family, run:
$ gcloud bigtable tables create my-table --instance=my-instance \
--column-families="my-family"
To create a table that has a column family named my-instance, a garbage
collection policy that lets data expire after 864,000 seconds, and initial
table splits on row keys car and key, run:
$ gcloud bigtable tables create my-table --instance=my-instance \
--column-families="my-family:maxage=864000s" --splits=car,key
To create a table my-table in instance my-instance that lets data in column
family my-family1 expire after 10 days and keeps a maximum of 5 cells per
column in column family my-family-2 if the data is less than 5 days old,
run:
$ gcloud bigtable tables create my-table --instance=my-instance \
--column-families="my-family-1:maxage=10d,my-family-2:maxversion\
s=5||maxage=5d"
To create a table my-table that has one column family my-family that lets
data expire after 10 days, and to enable a change stream for the table to
be kept for 7 days, run:
$ gcloud bigtable tables create my-table --instance=my-instance \
--column-families="my-family:maxage=10d" \
--change-stream-retention-period=7d
To create a deletion-protected table my-table in instance my-instance with
a column family my-family, run:
$ gcloud bigtable tables create my-table --instance=my-instance \
--column-families="my-family" --deletion-protection
To create a table my-table without deletion protection in instance
my-instance with a column family my-family, run:
$ gcloud bigtable tables create my-table --instance=my-instance \
--column-families="my-family" --no-deletion-protection
POSITIONAL ARGUMENTS
Table resource - Cloud Bigtable table 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 table 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.
TABLE
ID of the table or fully qualified identifier for the table.
To set the table attribute:
▸ provide the argument table on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--instance=INSTANCE
Name of the Cloud Bigtable instance.
To set the instance attribute:
▸ provide the argument table on the command line with a fully
specified name;
▸ provide the argument --instance on the command line.
REQUIRED FLAGS
--column-families=[COLUMN_FAMILIES,...]
A double-quote (") wrapped list of family name and corresponding
garbage collection rules concatenated by :, where the rules are
optional. For example: \
"family_1,family_2:maxage=5d&&maxversions=2,family_3:maxage=10d||maxversions=5"
OPTIONAL FLAGS
--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD
The length of time to retain change stream data for the table, in the
range of [1 day, 7 days]. Acceptable units are days (d), hours (h),
minutes (m), and seconds (s). Passing in a value for this option
enables a change stream for the table. Examples: 5d or 48h.
--deletion-protection
Once specified, the table is deletion protected.
--splits=[SPLITS,...]
Row keys where the table should initially be split. For example:
car,key
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 bigtableadmin/v2 API. The full documentation for this
API can be found at: https://cloud.google.com/bigtable/
NOTES
These variants are also available:
$ gcloud alpha bigtable tables create
$ gcloud beta bigtable tables create

65
gcloud/bigtable/tables/delete Normal file
View file

@ -0,0 +1,65 @@
NAME
gcloud bigtable tables delete - delete a Cloud Bigtable table
SYNOPSIS
gcloud bigtable tables delete (TABLE : --instance=INSTANCE)
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Delete a Cloud Bigtable table.
EXAMPLES
To delete the table my-table in instance my-instance, run:
$ gcloud bigtable tables delete my-table --instance=my-instance
POSITIONAL ARGUMENTS
Table resource - Cloud Bigtable table 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 table 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.
TABLE
ID of the table or fully qualified identifier for the table.
To set the table attribute:
▸ provide the argument table on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--instance=INSTANCE
Name of the Cloud Bigtable instance.
To set the instance attribute:
▸ provide the argument table on the command line with a fully
specified name;
▸ provide the argument --instance 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 bigtableadmin/v2 API. The full documentation for this
API can be found at: https://cloud.google.com/bigtable/
NOTES
These variants are also available:
$ gcloud alpha bigtable tables delete
$ gcloud beta bigtable tables delete

85
gcloud/bigtable/tables/describe Normal file
View file

@ -0,0 +1,85 @@
NAME
gcloud bigtable tables describe - retrieve information about a table
SYNOPSIS
gcloud bigtable tables describe (TABLE : --instance=INSTANCE)
[--view=VIEW; default="schema"] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Retrieve information about a table.
EXAMPLES
To describe a table, run:
$ gcloud bigtable tables describe TABLE_NAME --instance=INSTANCE_NAME
POSITIONAL ARGUMENTS
Table resource - Cloud Bigtable table to describe. 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 table 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.
TABLE
ID of the table or fully qualified identifier for the table.
To set the table attribute:
▸ provide the argument table on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--instance=INSTANCE
Name of the Cloud Bigtable instance.
To set the instance attribute:
▸ provide the argument table on the command line with a fully
specified name;
▸ provide the argument --instance on the command line.
FLAGS
--view=VIEW; default="schema"
The view to be applied to the returned table's fields. VIEW must be one
of:
encryption
Only populates name and fields related to the table's encryption
status.
full
Populates all fields.
name
Only populates name.
replication
Only populates name and fields related to the table's replication.
schema
Only populates name and fields related to the table's schema.
stats
Only populates name and fields related to the table's statistics
(e.g. TableStats and ColumnFamilyStats).
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 bigtableadmin/v2 API. The full documentation for this
API can be found at: https://cloud.google.com/bigtable/
NOTES
These variants are also available:
$ gcloud alpha bigtable tables describe
$ gcloud beta bigtable tables describe

98
gcloud/bigtable/tables/get-iam-policy Normal file
View file

@ -0,0 +1,98 @@
NAME
gcloud bigtable tables get-iam-policy - get an IAM policy on a Cloud
Bigtable table
SYNOPSIS
gcloud bigtable tables get-iam-policy (TABLE : --instance=INSTANCE)
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Get an IAM policy on a Cloud Bigtable table.
EXAMPLES
To get the IAM policy on the table 'my-table' in instance 'my-instance',
run:
$ gcloud bigtable tables get-iam-policy my-table \
--instance='my-instance'
See https://cloud.google.com/iam/docs/managing-policies for more
information.
POSITIONAL ARGUMENTS
Table resource - Cloud Bigtable table to get the IAM policy 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 table 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.
TABLE
ID of the table or fully qualified identifier for the table.
To set the table attribute:
▸ provide the argument table on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--instance=INSTANCE
Name of the Cloud Bigtable instance.
To set the instance attribute:
▸ provide the argument table on the command line with a fully
specified name;
▸ provide the argument --instance 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.
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 bigtableadmin/v2 API. The full documentation for this
API can be found at: https://cloud.google.com/bigtable/
NOTES
These variants are also available:
$ gcloud alpha bigtable tables get-iam-policy
$ gcloud beta bigtable tables get-iam-policy

57
gcloud/bigtable/tables/help Normal file
View file

@ -0,0 +1,57 @@
NAME
gcloud bigtable tables - query Cloud Bigtable tables
SYNOPSIS
gcloud bigtable tables COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Query Cloud Bigtable tables.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
add-iam-policy-binding
Add an IAM policy binding to a Cloud Bigtable table.
create
Create a new Cloud Bigtable table.
delete
Delete a Cloud Bigtable table.
describe
Retrieve information about a table.
get-iam-policy
Get an IAM policy on a Cloud Bigtable table.
list
List existing Bigtable instance tables.
remove-iam-policy-binding
Remove an IAM policy binding from a Cloud Bigtable table.
restore
Restore a Cloud Bigtable backup to a new table.
set-iam-policy
Set an IAM policy on a Cloud Bigtable table.
undelete
Undelete a previously deleted Cloud Bigtable table.
update
Update an existing Cloud Bigtable table.
NOTES
These variants are also available:
$ gcloud alpha bigtable tables
$ gcloud beta bigtable tables

67
gcloud/bigtable/tables/list Normal file
View file

@ -0,0 +1,67 @@
NAME
gcloud bigtable tables list - list existing Bigtable instance tables
SYNOPSIS
gcloud bigtable tables list --instances=[INSTANCE,...]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
EXAMPLES
To list all tables in an instance, run:
$ gcloud bigtable tables list --instances=INSTANCE_NAME
To list all tables in several instances, run: $ gcloud bigtable tables list \
--instances=INSTANCE_NAME1,INSTANCE_NAME2
REQUIRED FLAGS
--instances=[INSTANCE,...]
ID of the instances.
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.
NOTES
These variants are also available:
$ gcloud alpha bigtable tables list
$ gcloud beta bigtable tables list

150
gcloud/bigtable/tables/remove-iam-policy-binding Normal file
View file

@ -0,0 +1,150 @@
NAME
gcloud bigtable tables remove-iam-policy-binding - remove an IAM policy
binding from a Cloud Bigtable table
SYNOPSIS
gcloud bigtable tables remove-iam-policy-binding
(TABLE : --instance=INSTANCE) --member=PRINCIPAL --role=ROLE
[--all | --condition=[KEY=VALUE,...]
| --condition-from-file=CONDITION_FROM_FILE] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Remove an IAM policy binding from a Cloud Bigtable table. One binding
consists of a member, a role, and an optional condition.
EXAMPLES
To remove an IAM policy binding for the role of 'roles/editor' for the user
'test-user@gmail.com' with table 'my-table' in instance 'my-instance', run:
$ gcloud bigtable tables remove-iam-policy-binding my-table \
--instance='my-instance' --member='user:test-user@gmail.com' \
--role='roles/editor'
To remove an IAM policy binding which expires at the end of the year 2019
for the role of 'roles/bigtable.admin' and the user 'test-user@gmail.com'
with table 'my-table' in instance 'my-instance', run:
$ gcloud bigtable tables remove-iam-policy-binding my-table \
--instance='my-instance' --member='user:test-user@gmail.com' \
--role='roles/bigtable.admin' \
--condition='expression=request.time <
timestamp("2020-01-01T00:00:00Z"),title=expires_end_of_2019,descrip\
tion=Expires at midnight on 2019-12-31'
See https://cloud.google.com/iam/docs/managing-policies for details of
policy role and member types.
POSITIONAL ARGUMENTS
Table resource - Cloud Bigtable table to remove the IAM policy binding
from. 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 table 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.
TABLE
ID of the table or fully qualified identifier for the table.
To set the table attribute:
▸ provide the argument table on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--instance=INSTANCE
Name of the Cloud Bigtable instance.
To set the instance attribute:
▸ provide the argument table on the command line with a fully
specified name;
▸ provide the argument --instance on the command line.
REQUIRED FLAGS
--member=PRINCIPAL
The principal to remove the binding for. Should be of the form
user|group|serviceAccount:email or domain:domain.
Examples: user:test-user@gmail.com, group:admins@example.com,
serviceAccount:test123@example.domain.com, or
domain:example.domain.com.
Deleted principals have an additional deleted: prefix and a ?uid=UID
suffix, where UID is a unique identifier for the principal. Example:
deleted:user:test-user@gmail.com?uid=123456789012345678901.
Some resources also accept the following special values:
◆ allUsers - Special identifier that represents anyone who is on the
internet, with or without a Google account.
◆ allAuthenticatedUsers - Special identifier that represents anyone
who is authenticated with a Google account or a service account.
--role=ROLE
The role to remove the principal from.
OPTIONAL FLAGS
At most one of these can be specified:
--all
Remove all bindings with this role and principal, irrespective of any
conditions.
--condition=[KEY=VALUE,...]
The condition of the binding that you want to remove. When the
condition is explicitly specified as None (--condition=None), a
binding without a condition is removed. Otherwise, only a binding
with a condition that exactly matches the specified condition
(including the optional description) is removed. For more on
conditions, refer to the conditions overview guide:
https://cloud.google.com/iam/docs/conditions-overview
When using the --condition flag, include the following key-value
pairs:
expression
(Required) Condition expression that evaluates to True or False.
This uses a subset of Common Expression Language syntax.
If the condition expression includes a comma, use a different
delimiter to separate the key-value pairs. Specify the delimiter
before listing the key-value pairs. For example, to specify a
colon (:) as the delimiter, do the following:
--condition=^:^title=TITLE:expression=EXPRESSION. For more
information, see
https://cloud.google.com/sdk/gcloud/reference/topic/escaping.
title
(Required) A short string describing the purpose of the
expression.
description
(Optional) Additional description for the expression.
--condition-from-file=CONDITION_FROM_FILE
Path to a local JSON or YAML file that defines the condition. To see
available fields, see the help for --condition.
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 bigtableadmin/v2 API. The full documentation for this
API can be found at: https://cloud.google.com/bigtable/
NOTES
These variants are also available:
$ gcloud alpha bigtable tables remove-iam-policy-binding
$ gcloud beta bigtable tables remove-iam-policy-binding

122
gcloud/bigtable/tables/restore Normal file
View file

@ -0,0 +1,122 @@
NAME
gcloud bigtable tables restore - restore a Cloud Bigtable backup to a new
table
SYNOPSIS
gcloud bigtable tables restore
(--destination=DESTINATION
: --destination-instance=DESTINATION_INSTANCE)
(--source=SOURCE
: --source-cluster=SOURCE_CLUSTER --source-instance=SOURCE_INSTANCE)
[--async] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
This command restores a Cloud Bigtable backup to a new table.
EXAMPLES
To restore table 'table2' from backup 'backup1', run:
$ gcloud bigtable tables restore --source-instance=instance1 \
--source-cluster=cluster1 --source=backup1 \
--destination-instance=instance1 --destination=table2
To restore table 'table2' from backup 'backup1' in a different project,
run:
$ gcloud bigtable tables restore \
--source=projects/project1/instances/instance1/clusters/\
cluster1/backups/backup1 \
--destination=projects/project2/instances/instance2/tables/\
table2
REQUIRED FLAGS
Table resource - The destination to restore 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 --destination 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.
--destination=DESTINATION
ID of the table or fully qualified identifier for the table.
To set the destination attribute:
▸ provide the argument --destination on the command line.
This flag argument must be specified if any of the other arguments in
this group are specified.
--destination-instance=DESTINATION_INSTANCE
Name of the Cloud Bigtable instance.
To set the instance attribute:
▸ provide the argument --destination on the command line with a
fully specified name;
▸ provide the argument --destination-instance on the command line;
▸ provide the argument --source-instance on the command line.
Backup resource - The source to restore from. 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 --source 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.
--source=SOURCE
ID of the backup or fully qualified identifier for the backup.
To set the source attribute:
▸ provide the argument --source on the command line.
This flag argument must be specified if any of the other arguments in
this group are specified.
--source-cluster=SOURCE_CLUSTER
Name of the Cloud Bigtable cluster.
To set the cluster attribute:
▸ provide the argument --source on the command line with a fully
specified name;
▸ provide the argument --source-cluster on the command line.
--source-instance=SOURCE_INSTANCE
Name of the Cloud Bigtable instance.
To set the instance attribute:
▸ provide the argument --source on the command line with a fully
specified name;
▸ provide the argument --source-instance on the command line;
▸ provide the argument --destination-instance on the command line.
OPTIONAL 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.
NOTES
These variants are also available:
$ gcloud alpha bigtable tables restore
$ gcloud beta bigtable tables restore

78
gcloud/bigtable/tables/set-iam-policy Normal file
View file

@ -0,0 +1,78 @@
NAME
gcloud bigtable tables set-iam-policy - set an IAM policy on a Cloud
Bigtable table
SYNOPSIS
gcloud bigtable tables set-iam-policy (TABLE : --instance=INSTANCE)
POLICY_FILE [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Set an IAM policy on a Cloud Bigtable table.
EXAMPLES
To set the IAM policy from file 'my-policy' on the table 'my-table' in
instance 'my-instance', run:
$ gcloud bigtable tables set-iam-policy my-table \
--instance='my-instance' my-policy
See https://cloud.google.com/iam/docs/managing-policies for more
information.
POSITIONAL ARGUMENTS
Table resource - Cloud Bigtable table to set the IAM policy on. 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 table 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.
TABLE
ID of the table or fully qualified identifier for the table.
To set the table attribute:
▸ provide the argument table on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--instance=INSTANCE
Name of the Cloud Bigtable instance.
To set the instance attribute:
▸ provide the argument table on the command line with a fully
specified name;
▸ provide the argument --instance on the command line.
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.
API REFERENCE
This command uses the bigtableadmin/v2 API. The full documentation for this
API can be found at: https://cloud.google.com/bigtable/
NOTES
These variants are also available:
$ gcloud alpha bigtable tables set-iam-policy
$ gcloud beta bigtable tables set-iam-policy

71
gcloud/bigtable/tables/undelete Normal file
View file

@ -0,0 +1,71 @@
NAME
gcloud bigtable tables undelete - undelete a previously deleted Cloud
Bigtable table
SYNOPSIS
gcloud bigtable tables undelete (TABLE : --instance=INSTANCE) [--async]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Undelete a previously deleted Cloud Bigtable table.
EXAMPLES
To undelete the table my-table in instance my-instance, run:
$ gcloud bigtable tables undelete my-table --instance=my-instance
POSITIONAL ARGUMENTS
Table resource - Cloud Bigtable table to undelete. 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 table 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.
TABLE
ID of the table or fully qualified identifier for the table.
To set the table attribute:
▸ provide the argument table on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--instance=INSTANCE
Name of the Cloud Bigtable instance.
To set the instance attribute:
▸ provide the argument table on the command line with a fully
specified name;
▸ provide the argument --instance on the command line.
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 bigtableadmin/v2 API. The full documentation for this
API can be found at: https://cloud.google.com/bigtable/
NOTES
These variants are also available:
$ gcloud alpha bigtable tables undelete
$ gcloud beta bigtable tables undelete

105
gcloud/bigtable/tables/update Normal file
View file

@ -0,0 +1,105 @@
NAME
gcloud bigtable tables update - update an existing Cloud Bigtable table
SYNOPSIS
gcloud bigtable tables update (TABLE : --instance=INSTANCE) [--async]
[--deletion-protection]
[--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD
| --clear-change-stream-retention-period] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
Update an existing new Cloud Bigtable table with the specified
configuration.
EXAMPLES
To enable deletion protection, run:
$ gcloud bigtable tables update my-table --instance=my-instance \
--deletion-protection
To disable deletion protection, run:
$ gcloud bigtable tables update my-table --instance=my-instance \
--no-deletion-protection
To enable a change stream with a retention period of 1 day, or to update
your table's change stream retention period to 1 day, run:
$ gcloud bigtable tables update my-table --instance=my-instance \
--change-stream-retention-period=1d
To disable a change stream, run:
$ gcloud bigtable tables update my-table --instance=my-instance \
--clear-change-stream-retention-period
POSITIONAL ARGUMENTS
Table resource - Cloud Bigtable table 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 table 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.
TABLE
ID of the table or fully qualified identifier for the table.
To set the table attribute:
▸ provide the argument table on the command line.
This positional argument must be specified if any of the other
arguments in this group are specified.
--instance=INSTANCE
Name of the Cloud Bigtable instance.
To set the instance attribute:
▸ provide the argument table on the command line with a fully
specified name;
▸ provide the argument --instance on the command line.
FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
--deletion-protection
Once specified, the table is deletion protected.
At most one of these can be specified:
--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD
The length of time to retain change stream data for the table, in the
range of [1 day, 7 days]. Acceptable units are days (d), hours (h),
minutes (m), and seconds (s). If not already specified, enables a
change stream for the table. Examples: 5d or 48h.
--clear-change-stream-retention-period
This disables the change stream and eventually removes the change
stream data.
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 bigtableadmin/v2 API. The full documentation for this
API can be found at: https://cloud.google.com/bigtable/
NOTES
These variants are also available:
$ gcloud alpha bigtable tables update
$ gcloud beta bigtable tables update