gcloud beta managed-kafka consumer-groups update Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud beta managed-kafka consumer-groups update - update a Managed Service for Apache Kafka consumer group
- SYNOPSIS
gcloud beta managed-kafka consumer-groups update(CONSUMER_GROUP:--cluster=CLUSTER--location=LOCATION)--topics-file=JSON|YAML|FILE[GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(BETA)Update a Managed Service for Apache Kafka consumer group.- EXAMPLES
- To specify a file for updating the topics of a consumer group, run thefollowing:
$gcloudbetamanaged-kafkaconsumer-groupsupdatemyconsumergroup|--cluster=mycluster\--location=us-central1\--topics-file=topics.json
To update the topics of a consumer group with inline JSON, run the following:
$gcloudbetamanaged-kafkaconsumer-groupsupdatemyconsumergroup|--cluster=mycluster\--location=us-central1\--topics-file='{"topic":{"partitions":{"0":{"offset":1,"metadata":"metadata"}}}}'
- POSITIONAL ARGUMENTS
- Consumer group resource - Identifies the consumer group to be updated. Thearguments 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 inother ways.
To set the
projectattribute:- provide the argument
consumer_groupon the command line with afully specified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
CONSUMER_GROUP- ID of the consumer_group or fully qualified identifier for the consumer_group.
To set the
consumer_groupattribute:- provide the argument
consumer_groupon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--cluster=CLUSTER- The cluster name.To set the
clusterattribute:- provide the argument
consumer_groupon the command line with afully specified name; - provide the argument
--clusteron the command line.
- provide the argument
--location=LOCATION- ID of the location of the Managed Service for Apache Kafka resource. Seehttps://cloud.google.com/managed-service-for-apache-kafka/docs/locationsfor a list of supported locations.To set the
locationattribute:- provide the argument
consumer_groupon the command line with afully specified name; - provide the argument
--locationon the command line.
- provide the argument
- provide the argument
- Consumer group resource - Identifies the consumer group to be updated. Thearguments 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 inother ways.
- REQUIRED FLAGS
--topics-file=JSON|YAML|FILE- The path to the JSON or YAML file containing the configuration of the topics tobe updated for the consumer group. This also supports inline JSON or YAML.Required, sets
topics_filevalue.Input Example:--topics-file=stringFile Example:--topics-file=path_to_file.(yaml|json)
- 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 helpfor details. - API REFERENCE
- This command uses the
managedkafka/v1API. The full documentationfor this API can be found at:https://cloud.google.com/managed-service-for-apache-kafka/docs - NOTES
- This command is currently in beta and might change without notice. Thesevariants are also available:
gcloudmanaged-kafkaconsumer-groupsupdategcloudalphamanaged-kafkaconsumer-groupsupdate
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-22 UTC.