- NAME
-
- gcloud alpha pubsub lite-topics update - update a Pub/Sub Lite topic
- SYNOPSIS
-
-
gcloud alpha pubsub lite-topics update
(TOPIC
:--location
=LOCATION
) (--message-retention-period
=MESSAGE_RETENTION_PERIOD
--partitions
=PARTITIONS
--per-partition-bytes
=PER_PARTITION_BYTES
--per-partition-publish-mib
=PER_PARTITION_PUBLISH_MIB
--per-partition-subscribe-mib
=PER_PARTITION_SUBSCRIBE_MIB
--throughput-reservation
=THROUGHPUT_RESERVATION
) [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
-
(ALPHA)
Update a Pub/Sub Lite topic. - EXAMPLES
-
To update a Pub/Sub Lite topic, run:
gcloud alpha pubsub lite-topics update mytopic --location=us-central1-a --per-partition-publish-mib=10
- POSITIONAL ARGUMENTS
-
-
Topic resource - Topic to update. 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
--location
=LOCATION
-
ID of the location of the Pub/Sub Lite resource.
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
--zone
on the command line.
-
provide the argument
-
provide the argument
-
Topic resource - Topic to update. 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:
--message-retention-period
=MESSAGE_RETENTION_PERIOD
-
How long a published message is retained. If unset, messages will only be
dropped to make space for new ones once the
per-partition-bytes
limit is reached. A valid example value of this flag would bemessage-retention-period="2w"
. --partitions
=PARTITIONS
- Number of partitions in the topic.
--per-partition-bytes
=PER_PARTITION_BYTES
-
Provisioned storage, in bytes, per partition. If the number of bytes stored in
any of the topic's partitions exceeds this value, older messages will be dropped
to make room for newer ones, regardless of the value of
message-retention-period
. A valid example value of this flag would beper-partition-bytes=30GiB
. --per-partition-publish-mib
=PER_PARTITION_PUBLISH_MIB
- Topic partition publish throughput capacity in MiB/s. Must be between 4 and 16.
--per-partition-subscribe-mib
=PER_PARTITION_SUBSCRIBE_MIB
- Topic partition subscribe throughput capacity in MiB/s. Must be between 4 and 32.
--throughput-reservation
=THROUGHPUT_RESERVATION
- Reservation ID to use for topic throughput.
-
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
pubsublite/v1
API. The full documentation for this API can be found at: https://cloud.google.com/pubsub/lite/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 pubsub lite-topics update
gcloud beta pubsub lite-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-02-06 UTC.