feature/pubsub: add delay queue params for pulsar

This commit is contained in:
seachen 2021-09-01 10:37:51 +08:00
parent a30adfb062
commit 032b2b08ba
1 changed files with 39 additions and 3 deletions

View File

@ -24,16 +24,52 @@ spec:
value: "localhost:6650"
- name: enableTLS
value: "false"
```
## Spec metadata fields
| Field | Required | Details | Example |
|--------------------|:--------:|---------|---------|
| host | Y | Address of the Pulsar broker. Default is `"localhost:6650"` | `"localhost:6650"`
| host | Y | Address of the Pulsar broker. Default is `"localhost:6650"` | `"localhost:6650"`|
| enableTLS | N | Enable TLS. Default: `"false"` | `"true"`, `"false"`
### Delay queue
When invoking the Pulsar pub/sub, its possible to provide an optional delay queue by using the `metadata` query param in the request url.
These param names are `deliverAt` or `deliverAfter`.
| Field | Required | Details | Example |
|--------------------|:--------:|---------|---------|
| deliverAt | N | delay queue configuration param. Default is empty | `"2021-09-01 10:00:00"`|
| deliverAfter | N | delay queue configuration param. Default is empty | `"4h5m3s"`|
Example:
```shell
curl -X POST http://localhost:3500/v1.0/publish/myPulsar/myTopic?metadata.deliverAt='2021-09-01 10:00:00' \
-H "Content-Type: application/json" \
-d '{
"data": {
"message": "Hi"
}
}'
```
Or
```shell
curl -X POST http://localhost:3500/v1.0/publish/myPulsar/myTopic?metadata.deliverAfter='4h5m3s' \
-H "Content-Type: application/json" \
-d '{
"data": {
"message": "Hi"
}
}'
```
## Create a Pulsar instance
{{< tabs "Self-Hosted" "Kubernetes">}}
@ -60,4 +96,4 @@ Refer to the following [Helm chart](https://pulsar.apache.org/docs/en/kubernetes
## Related links
- [Basic schema for a Dapr component]({{< ref component-schema >}})
- Read [this guide]({{< ref "howto-publish-subscribe.md#step-2-publish-a-topic" >}}) for instructions on configuring pub/sub components
- [Pub/Sub building block]({{< ref pubsub >}})
- [Pub/Sub building block]({{< ref pubsub >}})