diff --git a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-pulsar.md b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-pulsar.md index 9f8b63a1e..2c4a25a23 100644 --- a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-pulsar.md +++ b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-pulsar.md @@ -24,16 +24,48 @@ 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"` -| enableTLS | N | Enable TLS. Default: `"false"` | `"true"`, `"false"` +| 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, it's possible to provide an optional delay queue by using the `metadata` query parameters in the request url. + +These optional parameter names are `metadata.deliverAt` or `metadata.deliverAfter`: +- `deliverAt`: Delay message to deliver at a specified time (RFC3339 format), e.g. `"2021-09-01T10:00:00Z"` +- `deliverAfter`: Delay message to deliver after a specified amount of time, e.g.`"4h5m3s"` + +Examples: + +```shell +curl -X POST http://localhost:3500/v1.0/publish/myPulsar/myTopic?metadata.deliverAt='2021-09-01T10:00:00Z' \ + -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 +92,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 >}}) \ No newline at end of file +- [Pub/Sub building block]({{< ref pubsub >}})