- NAME
-
- gcloud alpha managed-kafka consumer-groups update - update a Managed Service for Apache Kafka consumer group
- SYNOPSIS
-
-
gcloud alpha managed-kafka consumer-groups update
(CONSUMER_GROUP
:--cluster
=CLUSTER
--location
=LOCATION
)--topics-file
=JSON
|YAML
|FILE
[GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
-
(ALPHA)
Update a Managed Service for Apache Kafka consumer group. - EXAMPLES
-
To specify a file for updating the topics of a consumer group, run the
following:
$gcloud alpha managed-kafka consumer-groups update myconsumergroup | --cluster=mycluster \ --location=us-central1 \ --topics-file=topics.json
To update the topics of a consumer group with inline JSON, run the following:
$gcloud alpha managed-kafka consumer-groups update myconsumergroup | --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. 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
consumer_group
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.
CONSUMER_GROUP
-
ID of the consumer_group or fully qualified identifier for the consumer_group.
To set the
consumer_group
attribute:-
provide the argument
consumer_group
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
consumer_group
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
consumer_group
on the command line with a fully specified name; -
provide the argument
--location
on the command line.
-
provide the argument
-
provide the argument
-
Consumer group resource - Identifies the consumer group 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
-
--topics-file
=JSON
|YAML
|FILE
-
The path to the JSON or YAML file containing the configuration of the topics to
be updated for the consumer group. This also supports inline JSON or YAML.
Required, Sets
topics_file
value.Input Example:
--topics-file=string
File 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 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
-
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 managed-kafka consumer-groups update
gcloud beta managed-kafka consumer-groups 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.