This is an automated email from the ASF dual-hosted git repository.
urfree pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new 2d69859fcebf Docs sync done from apache/pulsar (#4ebbd2f)
2d69859fcebf is described below
commit 2d69859fcebf780c980f0edee7765b7a24322d2a
Author: github-actions[bot]
<41898282+github-actions[bot]@users.noreply.github.com>
AuthorDate: Tue Jan 16 01:32:53 2024 +0000
Docs sync done from apache/pulsar (#4ebbd2f)
---
.../reference/next/pulsar-admin/topicPolicies.md | 52 +++
static/swagger/master/swagger.json | 386 +++++++++++++++++++++
static/swagger/master/v2/swagger.json | 386 +++++++++++++++++++++
3 files changed, 824 insertions(+)
diff --git a/static/reference/next/pulsar-admin/topicPolicies.md
b/static/reference/next/pulsar-admin/topicPolicies.md
index 465aacb6323a..7df9309e89ca 100644
--- a/static/reference/next/pulsar-admin/topicPolicies.md
+++ b/static/reference/next/pulsar-admin/topicPolicies.md
@@ -1416,3 +1416,55 @@ $ pulsar-admin topicPolicies
remove-auto-subscription-creation options
|---|---|---|
| `--global, -g` | Whether to remove this policy globally. If set to true, the
policy will be replicate to other clusters asynchronously|false||
+
+## set-dispatcher-pause-on-ack-state-persistent
+
+Enable dispatcherPauseOnAckStatePersistent for a topic
+
+**Command:**
+
+```shell
+$ pulsar-admin topicPolicies set-dispatcher-pause-on-ack-state-persistent
options
+```
+
+**Options:**
+
+|Flag|Description|Default|
+|---|---|---|
+| `--global, -g` | Whether to set this policy globally. If set to true, the
policy will be replicate to other clusters asynchronously|false||
+
+
+## get-dispatcher-pause-on-ack-state-persistent
+
+Get the dispatcherPauseOnAckStatePersistent for a topic
+
+**Command:**
+
+```shell
+$ pulsar-admin topicPolicies get-dispatcher-pause-on-ack-state-persistent
options
+```
+
+**Options:**
+
+|Flag|Description|Default|
+|---|---|---|
+| `--applied, -a` | Get the applied policy of the topic|false||
+| `--global, -g` | Whether to get this policy globally. If set to true, broker
returned global topic policies|false||
+
+
+## remove-dispatcher-pause-on-ack-state-persistent
+
+Remove dispatcherPauseOnAckStatePersistent for a topic
+
+**Command:**
+
+```shell
+$ pulsar-admin topicPolicies remove-dispatcher-pause-on-ack-state-persistent
options
+```
+
+**Options:**
+
+|Flag|Description|Default|
+|---|---|---|
+| `--global, -g` | Whether to remove this policy globally. If set to true, the
policy will be replicate to other clusters asynchronously|false||
+
diff --git a/static/swagger/master/swagger.json
b/static/swagger/master/swagger.json
index 24c276bd2113..f61f76436b20 100644
--- a/static/swagger/master/swagger.json
+++ b/static/swagger/master/swagger.json
@@ -14474,6 +14474,199 @@
]
}
},
+
"/non-persistent/{tenant}/{namespace}/{topic}/dispatcherPauseOnAckStatePersistent":
{
+ "delete": {
+ "description": "",
+ "operationId":
"PersistentTopics_removeDispatcherPauseOnAckStatePersistent",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "tenant",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "namespace",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "topic",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "default": false,
+ "in": "query",
+ "name": "isGlobal",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "default": false,
+ "description": "Whether leader broker redirected this
call to this broker. For internal use.",
+ "in": "query",
+ "name": "authoritative",
+ "required": false,
+ "type": "boolean"
+ }
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "403": {
+ "description": "Don't have admin permission"
+ },
+ "404": {
+ "description": "Namespace or topic doesn't exist"
+ },
+ "405": {
+ "description": "Topic level policy is disabled, to
enable the topic level policy and retry"
+ },
+ "409": {
+ "description": "Concurrent modification"
+ }
+ },
+ "summary": "Remove dispatcher pause on ack state persistent
configuration for specified topic.",
+ "tags": [
+ "non-persistent topic"
+ ]
+ },
+ "get": {
+ "description": "",
+ "operationId":
"PersistentTopics_getDispatcherPauseOnAckStatePersistent",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "tenant",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "namespace",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "topic",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "default": false,
+ "in": "query",
+ "name": "applied",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "default": false,
+ "in": "query",
+ "name": "isGlobal",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "default": false,
+ "description": "Whether leader broker redirected this
call to this broker. For internal use.",
+ "in": "query",
+ "name": "authoritative",
+ "required": false,
+ "type": "boolean"
+ }
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "200": {
+ "description": "successful operation",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "403": {
+ "description": "Don't have admin permission"
+ },
+ "404": {
+ "description": "Tenant or cluster or namespace or
topic doesn't exist"
+ },
+ "500": {
+ "description": "Internal server error"
+ }
+ },
+ "summary": "Get dispatcher pause on ack state persistent
config on a topic.",
+ "tags": [
+ "non-persistent topic"
+ ]
+ },
+ "post": {
+ "description": "",
+ "operationId":
"PersistentTopics_setDispatcherPauseOnAckStatePersistent",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "tenant",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "namespace",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "topic",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "default": false,
+ "description": "Whether leader broker redirected this
call to this broker. For internal use.",
+ "in": "query",
+ "name": "authoritative",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "default": false,
+ "in": "query",
+ "name": "isGlobal",
+ "required": false,
+ "type": "boolean"
+ }
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "403": {
+ "description": "Don't have admin permission"
+ },
+ "404": {
+ "description": "Namespace or topic doesn't exist"
+ },
+ "405": {
+ "description": "Topic level policy is disabled, to
enable the topic level policy and retry"
+ },
+ "409": {
+ "description": "Concurrent modification"
+ }
+ },
+ "summary": "Set dispatcher pause on ack state persistent
configuration for specified topic.",
+ "tags": [
+ "non-persistent topic"
+ ]
+ }
+ },
"/non-persistent/{tenant}/{namespace}/{topic}/entryFilters": {
"delete": {
"description": "",
@@ -24314,6 +24507,199 @@
]
}
},
+
"/persistent/{tenant}/{namespace}/{topic}/dispatcherPauseOnAckStatePersistent":
{
+ "delete": {
+ "description": "",
+ "operationId":
"PersistentTopics_removeDispatcherPauseOnAckStatePersistent",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "tenant",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "namespace",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "topic",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "default": false,
+ "in": "query",
+ "name": "isGlobal",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "default": false,
+ "description": "Whether leader broker redirected this
call to this broker. For internal use.",
+ "in": "query",
+ "name": "authoritative",
+ "required": false,
+ "type": "boolean"
+ }
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "403": {
+ "description": "Don't have admin permission"
+ },
+ "404": {
+ "description": "Namespace or topic doesn't exist"
+ },
+ "405": {
+ "description": "Topic level policy is disabled, to
enable the topic level policy and retry"
+ },
+ "409": {
+ "description": "Concurrent modification"
+ }
+ },
+ "summary": "Remove dispatcher pause on ack state persistent
configuration for specified topic.",
+ "tags": [
+ "persistent topic"
+ ]
+ },
+ "get": {
+ "description": "",
+ "operationId":
"PersistentTopics_getDispatcherPauseOnAckStatePersistent",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "tenant",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "namespace",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "topic",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "default": false,
+ "in": "query",
+ "name": "applied",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "default": false,
+ "in": "query",
+ "name": "isGlobal",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "default": false,
+ "description": "Whether leader broker redirected this
call to this broker. For internal use.",
+ "in": "query",
+ "name": "authoritative",
+ "required": false,
+ "type": "boolean"
+ }
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "200": {
+ "description": "successful operation",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "403": {
+ "description": "Don't have admin permission"
+ },
+ "404": {
+ "description": "Tenant or cluster or namespace or
topic doesn't exist"
+ },
+ "500": {
+ "description": "Internal server error"
+ }
+ },
+ "summary": "Get dispatcher pause on ack state persistent
config on a topic.",
+ "tags": [
+ "persistent topic"
+ ]
+ },
+ "post": {
+ "description": "",
+ "operationId":
"PersistentTopics_setDispatcherPauseOnAckStatePersistent",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "tenant",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "namespace",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "topic",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "default": false,
+ "description": "Whether leader broker redirected this
call to this broker. For internal use.",
+ "in": "query",
+ "name": "authoritative",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "default": false,
+ "in": "query",
+ "name": "isGlobal",
+ "required": false,
+ "type": "boolean"
+ }
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "403": {
+ "description": "Don't have admin permission"
+ },
+ "404": {
+ "description": "Namespace or topic doesn't exist"
+ },
+ "405": {
+ "description": "Topic level policy is disabled, to
enable the topic level policy and retry"
+ },
+ "409": {
+ "description": "Concurrent modification"
+ }
+ },
+ "summary": "Set dispatcher pause on ack state persistent
configuration for specified topic.",
+ "tags": [
+ "persistent topic"
+ ]
+ }
+ },
"/persistent/{tenant}/{namespace}/{topic}/entryFilters": {
"delete": {
"description": "",
diff --git a/static/swagger/master/v2/swagger.json
b/static/swagger/master/v2/swagger.json
index 24c276bd2113..f61f76436b20 100644
--- a/static/swagger/master/v2/swagger.json
+++ b/static/swagger/master/v2/swagger.json
@@ -14474,6 +14474,199 @@
]
}
},
+
"/non-persistent/{tenant}/{namespace}/{topic}/dispatcherPauseOnAckStatePersistent":
{
+ "delete": {
+ "description": "",
+ "operationId":
"PersistentTopics_removeDispatcherPauseOnAckStatePersistent",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "tenant",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "namespace",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "topic",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "default": false,
+ "in": "query",
+ "name": "isGlobal",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "default": false,
+ "description": "Whether leader broker redirected this
call to this broker. For internal use.",
+ "in": "query",
+ "name": "authoritative",
+ "required": false,
+ "type": "boolean"
+ }
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "403": {
+ "description": "Don't have admin permission"
+ },
+ "404": {
+ "description": "Namespace or topic doesn't exist"
+ },
+ "405": {
+ "description": "Topic level policy is disabled, to
enable the topic level policy and retry"
+ },
+ "409": {
+ "description": "Concurrent modification"
+ }
+ },
+ "summary": "Remove dispatcher pause on ack state persistent
configuration for specified topic.",
+ "tags": [
+ "non-persistent topic"
+ ]
+ },
+ "get": {
+ "description": "",
+ "operationId":
"PersistentTopics_getDispatcherPauseOnAckStatePersistent",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "tenant",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "namespace",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "topic",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "default": false,
+ "in": "query",
+ "name": "applied",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "default": false,
+ "in": "query",
+ "name": "isGlobal",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "default": false,
+ "description": "Whether leader broker redirected this
call to this broker. For internal use.",
+ "in": "query",
+ "name": "authoritative",
+ "required": false,
+ "type": "boolean"
+ }
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "200": {
+ "description": "successful operation",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "403": {
+ "description": "Don't have admin permission"
+ },
+ "404": {
+ "description": "Tenant or cluster or namespace or
topic doesn't exist"
+ },
+ "500": {
+ "description": "Internal server error"
+ }
+ },
+ "summary": "Get dispatcher pause on ack state persistent
config on a topic.",
+ "tags": [
+ "non-persistent topic"
+ ]
+ },
+ "post": {
+ "description": "",
+ "operationId":
"PersistentTopics_setDispatcherPauseOnAckStatePersistent",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "tenant",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "namespace",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "topic",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "default": false,
+ "description": "Whether leader broker redirected this
call to this broker. For internal use.",
+ "in": "query",
+ "name": "authoritative",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "default": false,
+ "in": "query",
+ "name": "isGlobal",
+ "required": false,
+ "type": "boolean"
+ }
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "403": {
+ "description": "Don't have admin permission"
+ },
+ "404": {
+ "description": "Namespace or topic doesn't exist"
+ },
+ "405": {
+ "description": "Topic level policy is disabled, to
enable the topic level policy and retry"
+ },
+ "409": {
+ "description": "Concurrent modification"
+ }
+ },
+ "summary": "Set dispatcher pause on ack state persistent
configuration for specified topic.",
+ "tags": [
+ "non-persistent topic"
+ ]
+ }
+ },
"/non-persistent/{tenant}/{namespace}/{topic}/entryFilters": {
"delete": {
"description": "",
@@ -24314,6 +24507,199 @@
]
}
},
+
"/persistent/{tenant}/{namespace}/{topic}/dispatcherPauseOnAckStatePersistent":
{
+ "delete": {
+ "description": "",
+ "operationId":
"PersistentTopics_removeDispatcherPauseOnAckStatePersistent",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "tenant",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "namespace",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "topic",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "default": false,
+ "in": "query",
+ "name": "isGlobal",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "default": false,
+ "description": "Whether leader broker redirected this
call to this broker. For internal use.",
+ "in": "query",
+ "name": "authoritative",
+ "required": false,
+ "type": "boolean"
+ }
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "403": {
+ "description": "Don't have admin permission"
+ },
+ "404": {
+ "description": "Namespace or topic doesn't exist"
+ },
+ "405": {
+ "description": "Topic level policy is disabled, to
enable the topic level policy and retry"
+ },
+ "409": {
+ "description": "Concurrent modification"
+ }
+ },
+ "summary": "Remove dispatcher pause on ack state persistent
configuration for specified topic.",
+ "tags": [
+ "persistent topic"
+ ]
+ },
+ "get": {
+ "description": "",
+ "operationId":
"PersistentTopics_getDispatcherPauseOnAckStatePersistent",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "tenant",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "namespace",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "topic",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "default": false,
+ "in": "query",
+ "name": "applied",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "default": false,
+ "in": "query",
+ "name": "isGlobal",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "default": false,
+ "description": "Whether leader broker redirected this
call to this broker. For internal use.",
+ "in": "query",
+ "name": "authoritative",
+ "required": false,
+ "type": "boolean"
+ }
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "200": {
+ "description": "successful operation",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "403": {
+ "description": "Don't have admin permission"
+ },
+ "404": {
+ "description": "Tenant or cluster or namespace or
topic doesn't exist"
+ },
+ "500": {
+ "description": "Internal server error"
+ }
+ },
+ "summary": "Get dispatcher pause on ack state persistent
config on a topic.",
+ "tags": [
+ "persistent topic"
+ ]
+ },
+ "post": {
+ "description": "",
+ "operationId":
"PersistentTopics_setDispatcherPauseOnAckStatePersistent",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "tenant",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "namespace",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "in": "path",
+ "name": "topic",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "default": false,
+ "description": "Whether leader broker redirected this
call to this broker. For internal use.",
+ "in": "query",
+ "name": "authoritative",
+ "required": false,
+ "type": "boolean"
+ },
+ {
+ "default": false,
+ "in": "query",
+ "name": "isGlobal",
+ "required": false,
+ "type": "boolean"
+ }
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "403": {
+ "description": "Don't have admin permission"
+ },
+ "404": {
+ "description": "Namespace or topic doesn't exist"
+ },
+ "405": {
+ "description": "Topic level policy is disabled, to
enable the topic level policy and retry"
+ },
+ "409": {
+ "description": "Concurrent modification"
+ }
+ },
+ "summary": "Set dispatcher pause on ack state persistent
configuration for specified topic.",
+ "tags": [
+ "persistent topic"
+ ]
+ }
+ },
"/persistent/{tenant}/{namespace}/{topic}/entryFilters": {
"delete": {
"description": "",
