.TH "GCLOUD_ALPHA_LOGGING_BUCKETS_UPDATE" 1



.SH "NAME"
.HP
gcloud alpha logging buckets update \- update a bucket



.SH "SYNOPSIS"
.HP
\f5gcloud alpha logging buckets update\fR \fIBUCKET_ID\fR \fB\-\-location\fR=\fILOCATION\fR [\fB\-\-add\-index\fR=[\fIKEY\fR=\fIVALUE\fR,\ ...,...]] [\fB\-\-async\fR] [\fB\-\-clear\-indexes\fR] [\fB\-\-cmek\-kms\-key\-name\fR=\fICMEK_KMS_KEY_NAME\fR] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-enable\-analytics\fR] [\fB\-\-locked\fR] [\fB\-\-remove\-indexes\fR=[\fIFIELD\fR\ \fIPATH\fR,...]] [\fB\-\-restricted\-fields\fR=[\fIRESTRICTED_FIELD\fR,...]] [\fB\-\-retention\-days\fR=\fIRETENTION_DAYS\fR] [\fB\-\-update\-index\fR=[\fIKEY\fR=\fIVALUE\fR,\ ...,...]] [\fB\-\-billing\-account\fR=\fIBILLING_ACCOUNT_ID\fR\ |\ \fB\-\-folder\fR=\fIFOLDER_ID\fR\ |\ \fB\-\-organization\fR=\fIORGANIZATION_ID\fR\ |\ \fB\-\-project\fR=\fIPROJECT_ID\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Update the properties of a bucket.



.SH "EXAMPLES"

To update a bucket in your project, run:

.RS 2m
$ gcloud alpha logging buckets update my\-bucket \-\-location=global \e
   \-\-description=my\-new\-description
.RE

To update a bucket in your project and remove all indexes, run:

.RS 2m
$ gcloud alpha logging buckets update my\-bucket \-\-location=global \e
   \-\-clear\-indexes
.RE

To update a bucket in your project and remove an index, run:

.RS 2m
$ gcloud alpha logging buckets update my\-bucket \-\-location=global \e
   \-\-remove\-indexes=jsonPayload.foo2
.RE

To update a bucket in your project and add an index, run:

.RS 2m
$ gcloud alpha logging buckets update my\-bucket \-\-location=global \e
   \-\-add\-index=fieldPath=jsonPayload.foo2,type=INDEX_TYPE_STRING
.RE

To update a bucket in your project and update an existing index, run:

.RS 2m
$ gcloud alpha logging buckets update my\-bucket \-\-location=global \e
   \-\-update\-index=fieldPath=jsonPayload.foo,type=INDEX_TYPE_INTEGER
.RE

To update a bucket in your project and update existing cmek, run:

.RS 2m
$ gcloud alpha logging buckets update my\-bucket \-\-location=global \e
   \-\-cmek\-kms\-key\-name=CMEK_KEY_NAME
.RE

To asynchronously enroll a bucket in your project into Log Analytics, run:

.RS 2m
$ gcloud alpha logging buckets update my\-bucket \-\-location=global \e
   \-\-async \-\-enable\-analytics
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m
\fIBUCKET_ID\fR

The id of the bucket to update.


.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

Location of the bucket.


.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-add\-index\fR=[\fIKEY\fR=\fIVALUE\fR, ...,...]

Add an index to be added to the log bucket. This flag can be repeated. The
\f5\fIfieldPath\fR\fR and \f5\fItype\fR\fR attributes are required. For example:
\-\-index=fieldPath=jsonPayload.foo,type=INDEX_TYPE_STRING. The following keys
are accepted:

.RS 2m
.TP 2m
\fBfieldPath\fR
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.

.TP 2m
\fBtype\fR
The type of data in this index. For example: INDEX_TYPE_STRING Supported types
are strings and integers.

.RE
.sp
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

.TP 2m
\fB\-\-clear\-indexes\fR

Remove all logging indexes from the bucket.

.TP 2m
\fB\-\-cmek\-kms\-key\-name\fR=\fICMEK_KMS_KEY_NAME\fR

A valid \f5kms_key_name\fR will enable CMEK for the bucket.

.TP 2m
\fB\-\-description\fR=\fIDESCRIPTION\fR

A new description for the bucket.

.TP 2m
\fB\-\-enable\-analytics\fR

Whether to opt the bucket into Log Analytics. Once opted in, the bucket cannot
be opted out of Log Analytics.

.TP 2m
\fB\-\-locked\fR

Lock the bucket and prevent it from being modified or deleted (unless it is
empty).

.TP 2m
\fB\-\-remove\-indexes\fR=[\fIFIELD\fR \fIPATH\fR,...]

Specify the field path of the logging index(es) to delete.

.TP 2m
\fB\-\-restricted\-fields\fR=[\fIRESTRICTED_FIELD\fR,...]

A new set of restricted fields for the bucket.

.TP 2m
\fB\-\-retention\-days\fR=\fIRETENTION_DAYS\fR

A new retention period for the bucket.

.TP 2m
\fB\-\-update\-index\fR=[\fIKEY\fR=\fIVALUE\fR, ...,...]

Update an index to be added to the log bucket. This will update the type of the
index, and also update its createTime to the new update time. This flag can be
repeated. The \f5\fIfieldPath\fR\fR and \f5\fItype\fR\fR attributes are
required. For example:
\-\-index=fieldPath=jsonPayload.foo,type=INDEX_TYPE_STRING. The following keys
are accepted:

.RS 2m
.TP 2m
\fBfieldPath\fR
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.

.TP 2m
\fBtype\fR
The type of data in this index. For example: INDEX_TYPE_STRING Supported types
are strings and integers.

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-billing\-account\fR=\fIBILLING_ACCOUNT_ID\fR

Billing account of the bucket to update.

.TP 2m
\fB\-\-folder\fR=\fIFOLDER_ID\fR

Folder of the bucket to update.

.TP 2m
\fB\-\-organization\fR=\fIORGANIZATION_ID\fR

Organization of the bucket to update.

.TP 2m
\fB\-\-project\fR=\fIPROJECT_ID\fR

Project of the bucket to update.

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 \f5gcloud
config list \-\-format='text(core.project)'\fR and can be set using \f5gcloud
config set project PROJECTID\fR.

\f5\-\-project\fR and its fallback \f5core/project\fR 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 \f5\-\-billing\-project\fR or
\f5billing/quota_project\fR property.


.RE
.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "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:

.RS 2m
$ gcloud logging buckets update
.RE

.RS 2m
$ gcloud beta logging buckets update
.RE