Interface BroadcastSignalReq

interface BroadcastSignalReq {
    signalName: string;
    tenantId?: string;
    variables?: JSONDoc;
}

Properties

signalName: string

The name of the signal

tenantId?: string

Optional tenantId for a multi-tenant enabled cluster. This could also be supplied via environment variable.

variables?: JSONDoc

The signal variables as a JSON document; to be valid, the root of the document must be an object, e.g. { "a": "foo" }. [ "foo" ] would not be valid.