Skip to content

Commit

Permalink
Update command descriptions from old 'property/cluster/namespace' for…
Browse files Browse the repository at this point in the history
…mat to current 'tenant/namespace' format (apache#10485)

* Update command descriptions from old 'property/cluster/namespace' format to current 'tenant/namespace' format

* fix typo

* fix namespaces word

Co-authored-by: Chris Bartholomew <c_bartholomew@yahoo.com>
(cherry picked from commit c1ecb68)
(cherry picked from commit 96b3420)
  • Loading branch information
eolivelli authored and nicoloboschi committed Mar 1, 2022
1 parent 48204df commit d13ef6d
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 40 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ private NonPersistentTopics getNonPersistentTopics() {

@Parameters(commandDescription = "Lookup a topic from the current serving broker")
private class Lookup extends CliCommand {
@Parameter(description = "non-persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "non-persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Override
Expand All @@ -66,7 +66,7 @@ void run() throws PulsarAdminException {
@Parameters(commandDescription = "Get the stats for the topic and its connected producers and consumers. "
+ "All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.")
private class GetStats extends CliCommand {
@Parameter(description = "non-persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "non-persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Override
Expand All @@ -78,7 +78,7 @@ void run() throws PulsarAdminException {

@Parameters(commandDescription = "Get the internal stats for the topic")
private class GetInternalStats extends CliCommand {
@Parameter(description = "non-persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "non-persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Override
Expand All @@ -92,7 +92,7 @@ void run() throws PulsarAdminException {
+ "The partitioned topic has to be created before creating a producer on it.")
private class CreatePartitionedCmd extends CliCommand {

@Parameter(description = "non-persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "non-persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Parameter(names = { "-p",
Expand All @@ -110,7 +110,7 @@ void run() throws Exception {
+ "If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions")
private class GetPartitionedTopicMetadataCmd extends CliCommand {

@Parameter(description = "non-persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "non-persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Override
Expand All @@ -122,7 +122,7 @@ void run() throws Exception {

@Parameters(commandDescription = "Get list of non-persistent topics present under a namespace")
private class GetList extends CliCommand {
@Parameter(description = "property/cluster/namespace", required = true)
@Parameter(description = "tenant/namespace", required = true)
private java.util.List<String> params;

@Override
Expand All @@ -134,7 +134,7 @@ void run() throws PulsarAdminException {

@Parameters(commandDescription = "Get list of non-persistent topics present under a namespace bundle")
private class GetListInBundle extends CliCommand {
@Parameter(description = "property/cluster/namespace", required = true)
@Parameter(description = "tenant/namespace", required = true)
private java.util.List<String> params;

@Parameter(names = { "-b",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ private Topics getPersistentTopics() {

@Parameters(commandDescription = "Get the list of topics under a namespace.")
private class ListCmd extends CliCommand {
@Parameter(description = "property/cluster/namespace", required = true)
@Parameter(description = "tenant/namespace", required = true)
private java.util.List<String> params;

@Override
Expand All @@ -107,7 +107,7 @@ void run() throws PulsarAdminException {

@Parameters(commandDescription = "Get the list of partitioned topics under a namespace.")
private class PartitionedTopicListCmd extends CliCommand {
@Parameter(description = "property/cluster/namespace", required = true)
@Parameter(description = "tenant/namespace", required = true)
private java.util.List<String> params;

@Override
Expand All @@ -119,7 +119,7 @@ void run() throws PulsarAdminException {

@Parameters(commandDescription = "Grant a new permission to a client role on a single topic.")
private class GrantPermissions extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Parameter(names = "--role", description = "Client role to which grant permissions", required = true)
Expand All @@ -140,7 +140,7 @@ void run() throws PulsarAdminException {
+ "was not set at the topic level, but rather at the namespace level, this "
+ "operation will return an error (HTTP status code 412).")
private class RevokePermissions extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Parameter(names = "--role", description = "Client role to which revoke permissions", required = true)
Expand All @@ -158,7 +158,7 @@ void run() throws PulsarAdminException {
+ "by the permissions set at the namespace level combined (union) with any eventual "
+ "specific permission set on the topic.")
private class Permissions extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Override
Expand All @@ -170,7 +170,7 @@ void run() throws PulsarAdminException {

@Parameters(commandDescription = "Lookup a topic from the current serving broker")
private class Lookup extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Override
Expand All @@ -182,7 +182,7 @@ void run() throws PulsarAdminException {

@Parameters(commandDescription = "Get Namespace bundle range of a topic")
private class GetBundleRange extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Override
Expand All @@ -196,7 +196,7 @@ void run() throws PulsarAdminException {
+ "The partitioned topic has to be created before creating a producer on it.")
private class CreatePartitionedCmd extends CliCommand {

@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Parameter(names = { "-p",
Expand All @@ -214,7 +214,7 @@ void run() throws Exception {
+ "New updating number of partitions must be greater than existing number of partitions.")
private class UpdatePartitionedCmd extends CliCommand {

@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Parameter(names = { "-p",
Expand All @@ -232,7 +232,7 @@ void run() throws Exception {
+ "If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions")
private class GetPartitionedTopicMetadataCmd extends CliCommand {

@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Override
Expand All @@ -246,7 +246,7 @@ void run() throws Exception {
+ "It will also delete all the partitions of the topic if it exists.")
private class DeletePartitionedCmd extends CliCommand {

@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Parameter(names = "--force", description = "Close all producer/consumer/replicator and delete topic forcefully")
Expand All @@ -262,7 +262,7 @@ void run() throws Exception {
@Parameters(commandDescription = "Delete a topic. "
+ "The topic cannot be deleted if there's any active subscription or producers connected to it.")
private class DeleteCmd extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Parameter(names = "--force", description = "Close all producer/consumer/replicator and delete topic forcefully")
Expand All @@ -277,7 +277,7 @@ void run() throws PulsarAdminException {

@Parameters(commandDescription = "Unload a topic.")
private class UnloadCmd extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Override
Expand All @@ -302,7 +302,7 @@ void run() throws PulsarAdminException {

@Parameters(commandDescription = "Get the list of subscriptions on the topic")
private class ListSubscriptions extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Override
Expand All @@ -315,7 +315,7 @@ void run() throws Exception {
@Parameters(commandDescription = "Delete a durable subscriber from a topic. "
+ "The subscription cannot be deleted if there are any active consumers attached to it")
private class DeleteSubscription extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Parameter(names = { "-f",
Expand All @@ -335,7 +335,7 @@ void run() throws PulsarAdminException {
@Parameters(commandDescription = "Get the stats for the topic and its connected producers and consumers. "
+ "All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.")
private class GetStats extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Override
Expand All @@ -347,7 +347,7 @@ void run() throws PulsarAdminException {

@Parameters(commandDescription = "Get the internal stats for the topic")
private class GetInternalStats extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Parameter(names = { "-m",
Expand All @@ -363,7 +363,7 @@ void run() throws PulsarAdminException {

@Parameters(commandDescription = "Get the internal metadata info for the topic")
private class GetInternalInfo extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Override
Expand All @@ -378,7 +378,7 @@ void run() throws PulsarAdminException {
@Parameters(commandDescription = "Get the stats for the partitioned topic and its connected producers and consumers. "
+ "All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.")
private class GetPartitionedStats extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Parameter(names = "--per-partition", description = "Get per partition stats")
Expand All @@ -394,7 +394,7 @@ void run() throws Exception {
@Parameters(commandDescription = "Get the stats-internal for the partitioned topic and its connected producers and consumers. "
+ "All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.")
private class GetPartitionedStatsInternal extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Override
Expand All @@ -406,7 +406,7 @@ void run() throws Exception {

@Parameters(commandDescription = "Skip all the messages for the subscription")
private class SkipAll extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Parameter(names = { "-s", "--subscription" }, description = "Subscription to be cleared", required = true)
Expand All @@ -421,7 +421,7 @@ void run() throws PulsarAdminException {

@Parameters(commandDescription = "Skip some messages for the subscription")
private class Skip extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Parameter(names = { "-s",
Expand All @@ -440,7 +440,7 @@ void run() throws PulsarAdminException {

@Parameters(commandDescription = "Expire messages that older than given expiry time (in seconds) for the subscription")
private class ExpireMessages extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Parameter(names = { "-s",
Expand All @@ -459,7 +459,7 @@ void run() throws PulsarAdminException {

@Parameters(commandDescription = "Expire messages that older than given expiry time (in seconds) for all subscriptions")
private class ExpireMessagesForAllSubscriptions extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Parameter(names = { "-t", "--expireTime" }, description = "Expire messages older than time in seconds", required = true)
Expand All @@ -474,7 +474,7 @@ void run() throws PulsarAdminException {

@Parameters(commandDescription = "Create a new subscription on a topic")
private class CreateSubscription extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Parameter(names = { "-s",
Expand Down Expand Up @@ -503,7 +503,7 @@ void run() throws PulsarAdminException {

@Parameters(commandDescription = "Reset position for subscription to position closest to timestamp or messageId")
private class ResetCursor extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Parameter(names = { "-s",
Expand Down Expand Up @@ -539,7 +539,7 @@ void run() throws PulsarAdminException {

@Parameters(commandDescription = "Terminate a topic and don't allow any more messages to be published")
private class Terminate extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Override
Expand All @@ -557,7 +557,7 @@ void run() throws PulsarAdminException {

@Parameters(commandDescription = "Peek some messages for the subscription")
private class PeekMessages extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Parameter(names = { "-s",
Expand Down Expand Up @@ -635,7 +635,7 @@ void run() throws PulsarAdminException {

@Parameters(commandDescription = "Compact a topic")
private class Compact extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Override
Expand All @@ -649,7 +649,7 @@ void run() throws PulsarAdminException {

@Parameters(commandDescription = "Status of compaction on a topic")
private class CompactionStatusCmd extends CliCommand {
@Parameter(description = "persistent://property/cluster/namespace/topic", required = true)
@Parameter(description = "persistent://tenant/namespace/topic", required = true)
private java.util.List<String> params;

@Parameter(names = { "-w", "--wait-complete" },
Expand Down

0 comments on commit d13ef6d

Please sign in to comment.