UpstreamTemplateArgs

data class UpstreamTemplateArgs(val auth: Output<UpstreamAuthSettingsArgs>? = null, val categoryPattern: Output<String>? = null, val eventPattern: Output<String>? = null, val hubPattern: Output<String>? = null, val urlTemplate: Output<String>) : ConvertibleToJava<UpstreamTemplateArgs>

Upstream template item settings. It defines the Upstream URL of the incoming requests. The template defines the pattern of the event, the hub or the category of the incoming request that matches current URL template.

Constructors

Link copied to clipboard
constructor(auth: Output<UpstreamAuthSettingsArgs>? = null, categoryPattern: Output<String>? = null, eventPattern: Output<String>? = null, hubPattern: Output<String>? = null, urlTemplate: Output<String>)

Properties

Link copied to clipboard
val auth: Output<UpstreamAuthSettingsArgs>? = null

Upstream auth settings. If not set, no auth is used for upstream messages.

Link copied to clipboard
val categoryPattern: Output<String>? = null

Gets or sets the matching pattern for category names. If not set, it matches any category. There are 3 kind of patterns supported: 1. "*", it to matches any category name. 2. Combine multiple categories with ",", for example "connections,messages", it matches category "connections" and "messages". 3. The single category name, for example, "connections", it matches the category "connections".

Link copied to clipboard
val eventPattern: Output<String>? = null

Gets or sets the matching pattern for event names. If not set, it matches any event. There are 3 kind of patterns supported: 1. "*", it to matches any event name. 2. Combine multiple events with ",", for example "connect,disconnect", it matches event "connect" and "disconnect". 3. The single event name, for example, "connect", it matches "connect".

Link copied to clipboard
val hubPattern: Output<String>? = null

Gets or sets the matching pattern for hub names. If not set, it matches any hub. There are 3 kind of patterns supported: 1. "*", it to matches any hub name. 2. Combine multiple hubs with ",", for example "hub1,hub2", it matches "hub1" and "hub2". 3. The single hub name, for example, "hub1", it matches "hub1".

Link copied to clipboard
val urlTemplate: Output<String>

Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. For example, if the urlTemplate is http://example.com/{hub}/api/{event}, with a client request from hub chat connects, it will first POST to this URL: http://example.com/chat/api/connect.

Functions

Link copied to clipboard
open override fun toJava(): UpstreamTemplateArgs