- NAME
-
- gcloud alpha api-gateway gateways update - update an API Gateway
- SYNOPSIS
-
-
gcloud alpha api-gateway gateways update
(GATEWAY
:--location
=LOCATION
) [--async
] [--display-name
=DISPLAY_NAME
] [--update-labels
=[KEY
=VALUE
,…]] [--api-config
=API_CONFIG
:--api
=API
] [--clear-labels
|--remove-labels
=[KEY
,…]] [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
-
(ALPHA)
Update an API Gateway. - EXAMPLES
-
To update the display name of a gateway, run:
gcloud alpha api-gateway gateways update my-gateway --location=us-central1 --display-name="New Display Name"
- POSITIONAL ARGUMENTS
-
-
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
project
attribute:-
provide the argument
gateway
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.
GATEWAY
-
ID of the gateway or fully qualified identifier for the gateway.
To set the
gateway
attribute:-
provide the argument
gateway
on the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--location
=LOCATION
-
Cloud location for gateway.
To set the
location
attribute:-
provide the argument
gateway
on the command line with a fully specified name; -
provide the argument
--location
on the command line.
-
provide the argument
-
provide the argument
-
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.
- FLAGS
-
--async
- Return immediately, without waiting for the operation in progress to complete.
--display-name
=DISPLAY_NAME
- Human readable name which can optionally be supplied.
--update-labels
=[KEY
=VALUE
,…]-
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 (
-
), underscores (_
), lowercase characters, and numbers. Values must contain only hyphens (-
), underscores (_
), lowercase characters, and numbers. -
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
project
attribute:-
provide the argument
--api-config
on the command line with a fully specified name; -
provide the argument
--project
on the command line; -
set the property
core/project
.
To set the
location
attribute:-
provide the argument
--api-config
on the command line with a fully specified name; - Location for API and API Configs. Defaults to global.
--api-config
=API_CONFIG
-
ID of the api-config or fully qualified identifier for the api-config.
To set the
api-config
attribute:-
provide the argument
--api-config
on the command line.
This flag argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--api
=API
-
API ID.
To set the
api
attribute:-
provide the argument
--api-config
on the command line with a fully specified name; -
provide the argument
--api
on the command line.
-
provide the argument
-
provide the argument
-
At most one of these can be specified:
--clear-labels
-
Remove all labels. If
--update-labels
is also specified then--clear-labels
is applied first.For example, to remove all labels:
gcloud alpha api-gateway gateways update --clear-labels
To remove all existing labels and create two new labels,
andfoo
:baz
gcloud alpha api-gateway gateways update --clear-labels --update-labels foo=bar,baz=qux
--remove-labels
=[KEY
,…]-
List of label keys to remove. If a label does not exist it is silently ignored.
If
--update-labels
is also specified then--update-labels
is applied first.
- 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 api-gateway gateways update
gcloud beta api-gateway gateways update
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-02-06 UTC.