imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-20 21:20:07 +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

94
gcloud/alpha/logging/buckets/create Normal file
View file

@ -0,0 +1,94 @@
NAME
gcloud alpha logging buckets create - creates a bucket
SYNOPSIS
gcloud alpha logging buckets create BUCKET_ID --location=LOCATION
[--cmek-kms-key-name=CMEK_KMS_KEY_NAME] [--description=DESCRIPTION]
[--enable-analytics] [--index=[KEY=VALUE, ...,...]]
[--restricted-fields=[RESTRICTED_FIELD,...]]
[--retention-days=RETENTION_DAYS] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) After creating a bucket, use a log sink to route logs into the
bucket.
EXAMPLES
To create a bucket 'my-bucket' in location 'global', run:
$ gcloud alpha logging buckets create my-bucket --location=global \
--description="my custom bucket"
To create a bucket with extended retention, run:
$ gcloud alpha logging buckets create my-bucket --location=global \
--retention-days=365
To create a bucket in cloud region 'us-central1', run:
$ gcloud alpha logging buckets create my-bucket \
--location=us-central1
POSITIONAL ARGUMENTS
BUCKET_ID
ID of the bucket to create.
REQUIRED FLAGS
--location=LOCATION
Location in which to create the bucket. Once the bucket is created, the
location cannot be changed.
OPTIONAL FLAGS
--cmek-kms-key-name=CMEK_KMS_KEY_NAME
A valid kms_key_name will enable CMEK for the bucket.
--description=DESCRIPTION
A textual description for the bucket.
--enable-analytics
Whether to opt the bucket into advanced log analytics. This field may
only be set at bucket creation and cannot be changed later.
--index=[KEY=VALUE, ...,...]
Specify an index to be added to the log bucket. This flag can be
repeated. The fieldPath and type attributes are required. For example
--index=fieldPath=jsonPayload.foo,type=INDEX_TYPE_STRING. The following
keys are accepted:
fieldPath
The LogEntry field path to index.For example:
jsonPayload.request.status. Paths are limited to 800 characters and
can include only letters, digits, underscores, hyphens, and
periods.
type
The type of data in this index.For example: INDEX_TYPE_STRING
Supported types are INDEX_TYPE_STRING and INDEX_TYPE_INTEGER.
--restricted-fields=[RESTRICTED_FIELD,...]
Comma-separated list of field paths that require permission checks in
this bucket. The following fields and their children are eligible:
textPayload, jsonPayload, protoPayload, httpRequest, labels,
sourceLocation.
--retention-days=RETENTION_DAYS
The period logs will be retained, after which logs will automatically
be deleted. The default is 30 days.
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. These variants are also available:
$ gcloud logging buckets create
$ gcloud beta logging buckets create

66
gcloud/alpha/logging/buckets/delete Normal file
View file

@ -0,0 +1,66 @@
NAME
gcloud alpha logging buckets delete - delete a bucket
SYNOPSIS
gcloud alpha logging buckets delete BUCKET_ID --location=LOCATION
[--billing-account=BILLING_ACCOUNT_ID | --folder=FOLDER_ID
| --organization=ORGANIZATION_ID | --project=PROJECT_ID]
[GCLOUD_WIDE_FLAG ...]
EXAMPLES
To delete bucket 'my-bucket' in location 'global', run:
$ gcloud alpha logging buckets delete my-bucket --location=global
POSITIONAL ARGUMENTS
BUCKET_ID
ID of the bucket to delete.
REQUIRED FLAGS
--location=LOCATION
Location of the bucket.
OPTIONAL FLAGS
At most one of these can be specified:
--billing-account=BILLING_ACCOUNT_ID
Delete a bucket associated with this billing account.
--folder=FOLDER_ID
Delete a bucket associated with this folder.
--organization=ORGANIZATION_ID
Delete a bucket associated with this organization.
--project=PROJECT_ID
Delete a bucket associated with this project.
The Google Cloud project ID to use for this invocation. If omitted,
then the current project is assumed; the current project can be
listed using gcloud config list --format='text(core.project)' and can
be set using gcloud config set project PROJECTID.
--project and its fallback core/project property play two roles in
the invocation. It specifies the project of the resource to operate
on. It also specifies the project for API enablement check, quota,
and billing. To specify a different project for quota and billing,
use --billing-project or billing/quota_project property.
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. These variants are also available:
$ gcloud logging buckets delete
$ gcloud beta logging buckets delete

69
gcloud/alpha/logging/buckets/describe Normal file
View file

@ -0,0 +1,69 @@
NAME
gcloud alpha logging buckets describe - displays information about a bucket
SYNOPSIS
gcloud alpha logging buckets describe BUCKET_ID --location=LOCATION
[--billing-account=BILLING_ACCOUNT_ID | --folder=FOLDER_ID
| --organization=ORGANIZATION_ID | --project=PROJECT_ID]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Displays information about a bucket.
EXAMPLES
To describe a bucket in a project, run:
$ gcloud alpha logging buckets describe my-bucket --location=global
POSITIONAL ARGUMENTS
BUCKET_ID
The id of the bucket to describe.
REQUIRED FLAGS
--location=LOCATION
Location of the bucket.
OPTIONAL FLAGS
At most one of these can be specified:
--billing-account=BILLING_ACCOUNT_ID
Describe a bucket associated with this billing account.
--folder=FOLDER_ID
Describe a bucket associated with this folder.
--organization=ORGANIZATION_ID
Describe a bucket associated with this organization.
--project=PROJECT_ID
Describe a bucket associated with this project.
The Google Cloud project ID to use for this invocation. If omitted,
then the current project is assumed; the current project can be
listed using gcloud config list --format='text(core.project)' and can
be set using gcloud config set project PROJECTID.
--project and its fallback core/project property play two roles in
the invocation. It specifies the project of the resource to operate
on. It also specifies the project for API enablement check, quota,
and billing. To specify a different project for quota and billing,
use --billing-project or billing/quota_project property.
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. These variants are also available:
$ gcloud logging buckets describe
$ gcloud beta logging buckets describe

47
gcloud/alpha/logging/buckets/help Normal file
View file

@ -0,0 +1,47 @@
NAME
gcloud alpha logging buckets - manage Cloud Logging buckets
SYNOPSIS
gcloud alpha logging buckets COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Commands for managing Cloud Logging buckets. A bucket is a
container of logs that can be managed as a unit, for example by setting the
retention period.
GCLOUD WIDE FLAGS
These flags are available to all commands: --help.
Run $ gcloud help for details.
COMMANDS
COMMAND is one of the following:
create
(ALPHA) Creates a bucket.
delete
(ALPHA) Delete a bucket.
describe
(ALPHA) Displays information about a bucket.
list
(ALPHA) Lists the defined buckets.
undelete
(ALPHA) Undelete a bucket.
update
(ALPHA) Updates a bucket.
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. These variants are also available:
$ gcloud logging buckets
$ gcloud beta logging buckets

98
gcloud/alpha/logging/buckets/list Normal file
View file

@ -0,0 +1,98 @@
NAME
gcloud alpha logging buckets list - lists the defined buckets
SYNOPSIS
gcloud alpha logging buckets list [--location=LOCATION]
[--billing-account=BILLING_ACCOUNT_ID | --folder=FOLDER_ID
| --organization=ORGANIZATION_ID | --project=PROJECT_ID]
[--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
[--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Lists the buckets for a project.
EXAMPLES
To list the buckets in a project, run:
$ gcloud alpha logging buckets list
FLAGS
--location=LOCATION
Location from which to list buckets. By default, buckets in all
locations will be listed
At most one of these can be specified:
--billing-account=BILLING_ACCOUNT_ID
List buckets associated with this billing account.
--folder=FOLDER_ID
List buckets associated with this folder.
--organization=ORGANIZATION_ID
List buckets associated with this organization.
--project=PROJECT_ID
List buckets associated with this project.
The Google Cloud project ID to use for this invocation. If omitted,
then the current project is assumed; the current project can be
listed using gcloud config list --format='text(core.project)' and can
be set using gcloud config set project PROJECTID.
--project and its fallback core/project property play two roles in
the invocation. It specifies the project of the resource to operate
on. It also specifies the project for API enablement check, quota,
and billing. To specify a different project for quota and billing,
use --billing-project or billing/quota_project property.
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
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. These variants are also available:
$ gcloud logging buckets list
$ gcloud beta logging buckets list

66
gcloud/alpha/logging/buckets/undelete Normal file
View file

@ -0,0 +1,66 @@
NAME
gcloud alpha logging buckets undelete - undelete a bucket
SYNOPSIS
gcloud alpha logging buckets undelete BUCKET_ID --location=LOCATION
[--billing-account=BILLING_ACCOUNT_ID | --folder=FOLDER_ID
| --organization=ORGANIZATION_ID | --project=PROJECT_ID]
[GCLOUD_WIDE_FLAG ...]
EXAMPLES
To undelete bucket 'my-bucket' in location 'global', run:
$ gcloud alpha logging buckets undelete my-bucket --location=global
POSITIONAL ARGUMENTS
BUCKET_ID
ID of the bucket to undelete.
REQUIRED FLAGS
--location=LOCATION
Location of the bucket.
OPTIONAL FLAGS
At most one of these can be specified:
--billing-account=BILLING_ACCOUNT_ID
Undelete a bucket associated with this billing account.
--folder=FOLDER_ID
Undelete a bucket associated with this folder.
--organization=ORGANIZATION_ID
Undelete a bucket associated with this organization.
--project=PROJECT_ID
Undelete a bucket associated with this project.
The Google Cloud project ID to use for this invocation. If omitted,
then the current project is assumed; the current project can be
listed using gcloud config list --format='text(core.project)' and can
be set using gcloud config set project PROJECTID.
--project and its fallback core/project property play two roles in
the invocation. It specifies the project of the resource to operate
on. It also specifies the project for API enablement check, quota,
and billing. To specify a different project for quota and billing,
use --billing-project or billing/quota_project property.
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. These variants are also available:
$ gcloud logging buckets undelete
$ gcloud beta logging buckets undelete

111
gcloud/alpha/logging/buckets/update Normal file
View file

@ -0,0 +1,111 @@
NAME
gcloud alpha logging buckets update - updates a bucket
SYNOPSIS
gcloud alpha logging buckets update BUCKET_ID --location=LOCATION
[--add-index=[KEY=VALUE, ...,...]] [--clear-indexes]
[--cmek-kms-key-name=CMEK_KMS_KEY_NAME] [--description=DESCRIPTION]
[--enable-loglink] [--locked] [--remove-indexes=[FIELD PATH,...]]
[--restricted-fields=[RESTRICTED_FIELD,...]]
[--retention-days=RETENTION_DAYS] [--update-index=[KEY=VALUE, ...,...]]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Updates the properties of a bucket.
EXAMPLES
To update a bucket in your project, run:
$ gcloud alpha logging buckets update my-bucket --location=global \
--description=my-new-description
POSITIONAL ARGUMENTS
BUCKET_ID
The id of the bucket to update.
REQUIRED FLAGS
--location=LOCATION
Location of the bucket.
OPTIONAL FLAGS
--add-index=[KEY=VALUE, ...,...]
Add an index to be added to the log bucket. This flag can be repeated.
The fieldPath and type attributes are required. For example
--index=fieldPath=jsonPayload.foo,type=INDEX_TYPE_STRING. The following
keys are accepted:
fieldPath
The LogEntry field path to index.For example:
jsonPayload.request.status. Paths are limited to 800 characters and
can include only letters, digits, underscores, hyphens, and
periods.
type
The type of data in this index.For example: INDEX_TYPE_STRING
Supported types are Strings and Integers.
--clear-indexes
Remove all logging indexes from the bucket.
--cmek-kms-key-name=CMEK_KMS_KEY_NAME
A valid kms_key_name will enable CMEK for the bucket.
--description=DESCRIPTION
A new description for the bucket.
--enable-loglink
Enables a linked dataset in BigQuery corresponding to this log bucket.
The linked dataset contains authorized views which give a ready-only
access to logs in BigQuery. This option can only be enabled in a log
bucket with advanced log analytics enabled. Use --no-enable-loglink to
disable the linked dataset.
--locked
Lock the bucket and prevent it from being modified or deleted (unless
it is empty).
--remove-indexes=[FIELD PATH,...]
Specify the field path of the Logging index(es) to delete.
--restricted-fields=[RESTRICTED_FIELD,...]
A new set of restricted fields for the bucket.
--retention-days=RETENTION_DAYS
A new retention period for the bucket.
--update-index=[KEY=VALUE, ...,...]
Update an index to be added to the log bucket. This will update the
type of the index, and also update its create time to the new update
time.This flag can be repeated. The fieldPath and type attributes are
required. For example
--index=fieldPath=jsonPayload.foo,type=INDEX_TYPE_STRING. The following
keys are accepted:
fieldPath
The LogEntry field path to index. For example:
jsonPayload.request.status. Paths are limited to 800 characters and
can include only letters, digits, underscores, hyphens, and
periods.
type
The type of data in this index. For example: INDEX_TYPE_STRING
Supported types are Strings and Integers.
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. These variants are also available:
$ gcloud logging buckets update
$ gcloud beta logging buckets update