File: //snap/google-cloud-cli/396/help/man/man1/gcloud_beta_logging_sinks_update.1
.TH "GCLOUD_BETA_LOGGING_SINKS_UPDATE" 1
.SH "NAME"
.HP
gcloud beta logging sinks update \- update a sink
.SH "SYNOPSIS"
.HP
\f5gcloud beta logging sinks update\fR \fISINK_NAME\fR [\fIDESTINATION\fR] [\fB\-\-add\-exclusion\fR=[\fIdescription\fR=\fIDESCRIPTION\fR],[\fIdisabled\fR=\fIDISABLED\fR],[\fIfilter\fR=\fIFILTER\fR],[\fIname\fR=\fINAME\fR]] [\fB\-\-clear\-exclusions\fR] [\fB\-\-custom\-writer\-identity\fR=\fISERVICE_ACCOUNT_EMAIL\fR] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-disabled\fR] [\fB\-\-include\-children\fR] [\fB\-\-intercept\-children\fR] [\fB\-\-log\-filter\fR=\fILOG_FILTER\fR] [\fB\-\-remove\-exclusions\fR=[\fIEXCLUSION\fR\ \fIID\fR,...]] [\fB\-\-update\-exclusion\fR=[\fIdescription\fR=\fIDESCRIPTION\fR],[\fIdisabled\fR=\fIDISABLED\fR],[\fIfilter\fR=\fIFILTER\fR],[\fIname\fR=\fINAME\fR]] [\fB\-\-use\-partitioned\-tables\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(BETA)\fR Change the \fB[DESTINATION]\fR or \fB\-\-log\-filter\fR associated
with a sink. The new destination must already exist and Cloud Logging must have
permission to write to it.
Log entries are exported to the new destination immediately.
.SH "EXAMPLES"
To only update a sink filter, run:
.RS 2m
$ gcloud beta logging sinks update my\-sink \e
\-\-log\-filter='severity>=ERROR'
.RE
Detailed information about filters can be found at:
https://cloud.google.com/logging/docs/view/logging\-query\-language
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
\fISINK_NAME\fR
The name of the sink to update.
.TP 2m
[\fIDESTINATION\fR]
A new destination for the sink. If omitted, the sink's existing destination is
unchanged.
.RE
.sp
.SH "FLAGS"
.RS 2m
.TP 2m
\fB\-\-add\-exclusion\fR=[\fIdescription\fR=\fIDESCRIPTION\fR],[\fIdisabled\fR=\fIDISABLED\fR],[\fIfilter\fR=\fIFILTER\fR],[\fIname\fR=\fINAME\fR]
Add an exclusion filter for log entries that are not to be routed to the sink'
destination. This flag can be repeated.
The \f5\fIname\fR\fR and \f5\fIfilter\fR\fR attributes are required. The
following keys are accepted:
.RS 2m
.TP 2m
\fBname\fR
Required. An identifier, such as \f5\fIload\-balancer\-exclusion\fR\fR.
Identifiers are limited to 100 characters and can include only letters, digits,
underscores, hyphens, and periods.
.TP 2m
\fBdescription\fR
Optional. A description of this exclusion.
.TP 2m
\fBfilter\fR
Required. Entries that match this advanced log filter will be excluded. Filter
cannot be empty.
.TP 2m
\fBdisabled\fR
Optional. By default, an exclusion is not disabled. To disable an exclusion,
include this key and specify any value.
.RE
.sp
.TP 2m
\fB\-\-clear\-exclusions\fR
Remove all logging exclusions from the sink.
.TP 2m
\fB\-\-custom\-writer\-identity\fR=\fISERVICE_ACCOUNT_EMAIL\fR
Writer identity for the sink. This flag can only be used if the destination is a
log bucket in a different project. The writer identity is automatically
generated when it is not provided for a sink.
.TP 2m
\fB\-\-description\fR=\fIDESCRIPTION\fR
Description of the sink.
.TP 2m
\fB\-\-disabled\fR
Disable the sink. Disabled sinks do not route logs to the sink destination.
Specify \-\-no\-disabled to enable a disabled sink. If this flag is not
specified, the value will not be updated.
.TP 2m
\fB\-\-include\-children\fR
Whether to export logs from all child projects and folders. Only applies to
sinks for organizations and folders.
.TP 2m
\fB\-\-intercept\-children\fR
Whether to intercept logs from all child projects and folders. Only applies to
sinks for organizations and folders.
.TP 2m
\fB\-\-log\-filter\fR=\fILOG_FILTER\fR
A new filter expression for the sink. If omitted, the sink's existing filter (if
any) is unchanged.
.TP 2m
\fB\-\-remove\-exclusions\fR=[\fIEXCLUSION\fR \fIID\fR,...]
Specify the name of the Logging exclusion(s) to delete.
.TP 2m
\fB\-\-update\-exclusion\fR=[\fIdescription\fR=\fIDESCRIPTION\fR],[\fIdisabled\fR=\fIDISABLED\fR],[\fIfilter\fR=\fIFILTER\fR],[\fIname\fR=\fINAME\fR]
Update an exclusion filter for a log entry that is not to be exported. This flag
can be repeated.
The \f5\fIname\fR\fR attribute is required. The following keys are accepted:
.RS 2m
.TP 2m
\fBname\fR
Required. An identifier, such as \f5\fIload\-balancer\-exclusion\fR\fR.
Identifiers are limited to 100 characters and can include only letters, digits,
underscores, hyphens, and periods.
.TP 2m
\fBdescription\fR
Optional. A description of this exclusion.
.TP 2m
\fBfilter\fR
Optional. Entries that match this advanced log filter will be excluded. Filter
cannot be empty.
.TP 2m
\fBdisabled\fR
Optional. To disable an exclusion, include this key and specify any value. To
enable a disabled exclusion, include this key, but do not specify any value. Do
not include this key unless you want to change its value.
.RE
.sp
.TP 2m
Settings for sink exporting data to BigQuery.
.RS 2m
.TP 2m
\fB\-\-use\-partitioned\-tables\fR
If specified, use BigQuery's partitioned tables. By default, Logging creates
dated tables based on the log entries' timestamps, e.g. 'syslog_20170523'.
Partitioned tables remove the suffix and special query syntax
(https://cloud.google.com/bigquery/docs/querying\-partitioned\-tables) must be
used.
.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 sink to update.
.TP 2m
\fB\-\-folder\fR=\fIFOLDER_ID\fR
Folder of the sink to update.
.TP 2m
\fB\-\-organization\fR=\fIORGANIZATION_ID\fR
Organization of the sink to update.
.TP 2m
\fB\-\-project\fR=\fIPROJECT_ID\fR
Project of the sink 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 beta and might change without notice. These
variants are also available:
.RS 2m
$ gcloud logging sinks update
.RE
.RS 2m
$ gcloud alpha logging sinks update
.RE