github.com/Jeffail/benthos/v3@v3.65.0/website/docs/components/outputs/pulsar.md (about) 1 --- 2 title: pulsar 3 type: output 4 status: experimental 5 categories: ["Services"] 6 --- 7 8 <!-- 9 THIS FILE IS AUTOGENERATED! 10 11 To make changes please edit the contents of: 12 lib/output/pulsar.go 13 --> 14 15 import Tabs from '@theme/Tabs'; 16 import TabItem from '@theme/TabItem'; 17 18 :::caution EXPERIMENTAL 19 This component is experimental and therefore subject to change or removal outside of major version releases. 20 ::: 21 Write messages to an Apache Pulsar server. 22 23 Introduced in version 3.43.0. 24 25 26 <Tabs defaultValue="common" values={[ 27 { label: 'Common', value: 'common', }, 28 { label: 'Advanced', value: 'advanced', }, 29 ]}> 30 31 <TabItem value="common"> 32 33 ```yaml 34 # Common config fields, showing default values 35 output: 36 label: "" 37 pulsar: 38 url: "" 39 topic: "" 40 key: "" 41 ordering_key: "" 42 max_in_flight: 1 43 ``` 44 45 </TabItem> 46 <TabItem value="advanced"> 47 48 ```yaml 49 # All config fields, showing default values 50 output: 51 label: "" 52 pulsar: 53 url: "" 54 topic: "" 55 key: "" 56 ordering_key: "" 57 max_in_flight: 1 58 auth: 59 oauth2: 60 enabled: false 61 audience: "" 62 issuer_url: "" 63 private_key_file: "" 64 token: 65 enabled: false 66 token: "" 67 ``` 68 69 </TabItem> 70 </Tabs> 71 72 ## Fields 73 74 ### `url` 75 76 A URL to connect to. 77 78 79 Type: `string` 80 Default: `""` 81 82 ```yaml 83 # Examples 84 85 url: pulsar://localhost:6650 86 87 url: pulsar://pulsar.us-west.example.com:6650 88 89 url: pulsar+ssl://pulsar.us-west.example.com:6651 90 ``` 91 92 ### `topic` 93 94 A topic to publish to. 95 96 97 Type: `string` 98 Default: `""` 99 100 ### `key` 101 102 The key to publish messages with. 103 This field supports [interpolation functions](/docs/configuration/interpolation#bloblang-queries). 104 105 106 Type: `string` 107 Default: `""` 108 109 ### `ordering_key` 110 111 The ordering key to publish messages with. 112 This field supports [interpolation functions](/docs/configuration/interpolation#bloblang-queries). 113 114 115 Type: `string` 116 Default: `""` 117 118 ### `max_in_flight` 119 120 The maximum number of messages to have in flight at a given time. Increase this to improve throughput. 121 122 123 Type: `int` 124 Default: `1` 125 126 ### `auth` 127 128 Optional configuration of Pulsar authentication methods. 129 130 131 Type: `object` 132 Requires version 3.60.0 or newer 133 134 ### `auth.oauth2` 135 136 Parameters for Pulsar OAuth2 authentication. 137 138 139 Type: `object` 140 141 ### `auth.oauth2.enabled` 142 143 Whether OAuth2 is enabled. 144 145 146 Type: `bool` 147 Default: `false` 148 149 ```yaml 150 # Examples 151 152 enabled: true 153 ``` 154 155 ### `auth.oauth2.audience` 156 157 OAuth2 audience. 158 159 160 Type: `string` 161 Default: `""` 162 163 ### `auth.oauth2.issuer_url` 164 165 OAuth2 issuer URL. 166 167 168 Type: `string` 169 Default: `""` 170 171 ### `auth.oauth2.private_key_file` 172 173 File containing the private key. 174 175 176 Type: `string` 177 Default: `""` 178 179 ### `auth.token` 180 181 Parameters for Pulsar Token authentication. 182 183 184 Type: `object` 185 186 ### `auth.token.enabled` 187 188 Whether Token Auth is enabled. 189 190 191 Type: `bool` 192 Default: `false` 193 194 ```yaml 195 # Examples 196 197 enabled: true 198 ``` 199 200 ### `auth.token.token` 201 202 Actual base64 encoded token. 203 204 205 Type: `string` 206 Default: `""` 207 208