Message Streaming Provider
In most cases, the provider is a simple string alias that matches a configuration
section from the
Assuming that an environment's
default provider has been
configured, the provider alias may be omitted from the configuration.
list of providers must be overridden for some reason, the following feature may be
leveraged. Instead of using the
alias of a
provider configured on the API server, you may use a special
URI to embed connection details within the tenant
The form of the
A valid URI must include the following sections:The Table1: Parameter explains the
URIfields and relevant description of the parameters.
|This field defines a valid broker type and protocol. Currently,
Use this simple
Python2 command shown as
echo '789secretkey999' | python2 -c 'import urllib, sys; sys.stdout.writelines(urllib.quote_plus(l, safe="/\n") for l in sys.stdin)'
following example displays how the
echo -n '789secretkey999' | python3 -c 'import urllib.parse, sys; sys.stdout.writelines(urllib.parse.quote_plus(sys.stdin.readline()))'
you are using
URI style configuration, it is important to encode
characters that are not legal within
URI fields. The most common
case is the occurrence of a slash
/ character in
Secret-Keys. Common encodings are listed below.
Use the following list of special characters that must be encoded with the corresponding ASCII format as displayed in the Table2: Encodings.
The type of destination may be provider specific. If
this is omitted, the default type is
queue. Supported types
- queue- supported by both ActiveMQ and Amazon SQS
- topic- supported by all: ActiveMQ, Amazon SNS, and Google PubSub
The name of the destination can be any arbitrary string.
Character restrictions may be provider specific.
The Provider Restriction table displays the list of providers along with the character restrictions.
|The names can be a combination of alphanumeric characters. |
For example, the '.' (dot), '-'(dash) or '_' (underscore) characters.
|The names can be a combination of alphanumeric characters and the
'-' (dash) or '_'
Note: The '.' (dot) is invalid in
|Names must start with a letter, and includes only the following
|Names can include letters, numbers, periods (.), hyphens (-), underscores (_), and slashes (/), up to 260 characters. Must start and end with a letter or number. Queue names are also case-insensitive.|
The Restriction for Queue Name table displays the naming convention for queue names.
|Just a simple string name, there is no special ID format.|
ARN in the following format:
|GCP resource identifier for
|Azure resource identifier for queues or
The naming convention is observed when assigning destination names to
tenants. It is especially important to maintain uniqueness, as multiple tenants with
the same destination name will have their data mixed within the queue or topic. A
suggested convention is to use a character-separated sequence which includes the
tenant-id. It is followed
The example for a
queue.TestTenant.allEvents. The example