- NAME
-
- gcloud managed-kafka topics update - update a Managed Service for Apache Kafka topic
- SYNOPSIS
-
-
gcloud managed-kafka topics update
(TOPIC
:--cluster
=CLUSTER
--location
=LOCATION
) (--partitions
=PARTITIONS
--clear-configs
|--configs
=[KEY
=VALUE
,…]) [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
- Update a Managed Service for Apache Kafka topic.
- EXAMPLES
-
To update an attribute in a topic, such as the partitions, for a cluster named
mycluster located in us-central1, run the following:
gcloud managed-kafka topics update mytopic --cluster=mycluster --location=us-central1 --partitions=3
- POSITIONAL ARGUMENTS
-
-
Topic resource - Identifies the topic to 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
topic
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.
TOPIC
-
ID of the topic or fully qualified identifier for the topic.
To set the
topic
attribute:-
provide the argument
topic
on the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--cluster
=CLUSTER
-
The cluster name.
To set the
cluster
attribute:-
provide the argument
topic
on the command line with a fully specified name; -
provide the argument
--cluster
on the command line.
-
provide the argument
--location
=LOCATION
-
ID of the location of the Managed Service for Apache Kafka resource. See https://cloud.google.com/managed-service-for-apache-kafka/docs/locations
for a list of supported locations.
To set the
location
attribute:-
provide the argument
topic
on the command line with a fully specified name; -
provide the argument
--location
on the command line.
-
provide the argument
-
provide the argument
-
Topic resource - Identifies the topic to 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.
- REQUIRED FLAGS
-
-
At least one of these must be specified:
--partitions
=PARTITIONS
- The number of partitions in a topic. You can increase the partition count for a topic, but you cannot decrease it. Increasing partitions for a topic that uses a key might change how messages are distributed.
-
At most one of these can be specified:
--clear-configs
- Remove all the configurations for the topic.
--configs
=[KEY
=VALUE
,…]-
Configuration for the topic that are overridden from the cluster defaults. The
key of the map is a Kafka topic property name, for example:
cleanup.policy=compact
,compression.type=producer
. If you provide a map with a key that already exists, only that configuration is updated. If the map contains a key that does not exist, the entry is appended to the topic configuration.
-
At least one of these must be specified:
- 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. - API REFERENCE
-
This command uses the
managedkafka/v1
API. The full documentation for this API can be found at: https://cloud.google.com/managed-service-for-apache-kafka/docs - NOTES
-
These variants are also available:
gcloud alpha managed-kafka topics update
gcloud beta managed-kafka topics 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-11-12 UTC.