.TH "GCLOUD_BETA_API\-GATEWAY_GATEWAYS_UPDATE" 1



.SH "NAME"
.HP
gcloud beta api\-gateway gateways update \- update an API Gateway



.SH "SYNOPSIS"
.HP
\f5gcloud beta api\-gateway gateways update\fR (\fIGATEWAY\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) [\fB\-\-async\fR] [\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR] [\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-api\-config\fR=\fIAPI_CONFIG\fR\ :\ \fB\-\-api\fR=\fIAPI\fR] [\fB\-\-clear\-labels\fR\ |\ \fB\-\-remove\-labels\fR=[\fIKEY\fR,...]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(BETA)\fR Update an API Gateway.



.SH "EXAMPLES"

To update the display name of a gateway, run:

.RS 2m
$ gcloud beta api\-gateway gateways update my\-gateway \e
    \-\-location=us\-central1 \-\-display\-name="New Display Name"
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Gateway resource \- Name for gateway which will be updated. 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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5gateway\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIGATEWAY\fR

ID of the gateway or fully qualified identifier for the gateway.

To set the \f5gateway\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5gateway\fR on the command line.
.RE
.sp

This positional argument must be specified if any of the other arguments in this
group are specified.

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

Cloud location for gateway.

To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5gateway\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

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

.TP 2m
\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR

Human readable name which can optionally be supplied.

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

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 (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

.TP 2m

Api config resource \- Resource name for API config the gateway will use. 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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-api\-config\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

To set the \f5location\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5\-\-api\-config\fR on the command line with a fully
specified name;
.IP "\(em" 2m
Location for API and API Configs. Defaults to global.
.RE
.sp


.RS 2m
.TP 2m
\fB\-\-api\-config\fR=\fIAPI_CONFIG\fR

ID of the api\-config or fully qualified identifier for the api\-config.

To set the \f5api\-config\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-api\-config\fR on the command line.
.RE
.sp

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-api\fR=\fIAPI\fR

API ID.

To set the \f5api\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5\-\-api\-config\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-api\fR on the command line.
.RE
.sp

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-labels\fR

Remove all labels. If \f5\-\-update\-labels\fR is also specified then
\f5\-\-clear\-labels\fR is applied first.

For example, to remove all labels:

.RS 2m
$ gcloud beta api\-gateway gateways update \-\-clear\-labels
.RE

To remove all existing labels and create two new labels, \f5\fIfoo\fR\fR and
\f5\fIbaz\fR\fR:

.RS 2m
$ gcloud beta api\-gateway gateways update \-\-clear\-labels \e
  \-\-update\-labels foo=bar,baz=qux
.RE

.TP 2m
\fB\-\-remove\-labels\fR=[\fIKEY\fR,...]

List of label keys to remove. If a label does not exist it is silently ignored.
If \f5\-\-update\-labels\fR is also specified then \f5\-\-update\-labels\fR is
applied first.


.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 api\-gateway gateways update
.RE

.RS 2m
$ gcloud alpha api\-gateway gateways update
.RE