sub

func At ¶ added in v1.27.0

func At(method string, route string) Option

At sets both the method and the route of a subscription in a single option. It is shorthand for Method followed by Route. Same method validation rules apply.

func Automatic ¶ added in v1.30.0

func Automatic() Option

Automatic clears the Manual flag, restoring the default automatic activate/deactivate behavior.

func DefaultQueue ¶

func DefaultQueue() Option

DefaultQueue names the queue of this subscription to the hostname of the service. Requests will be load-balanced among all instances of this microservice.

func Description ¶ added in v1.27.0

func Description(text string) Option

Description sets a human-readable description for the subscription. Used by the built-in OpenAPI handler.

func Function ¶ added in v1.27.0

func Function(inputs any, outputs any) Option

Function declares the subscription as a typed function (RPC) endpoint. The inputs and outputs values are zero-value struct instances used for OpenAPI schema reflection.

func InboundEvent ¶ added in v1.27.0

func InboundEvent(inputs any, outputs any) Option

InboundEvent declares the subscription as an inbound event sink. The inputs and outputs values are zero-value struct instances used for OpenAPI schema reflection.

func Manual ¶ added in v1.30.0

func Manual() Option

Manual opts the subscription out of the connector's automatic activate/deactivate passes. User code drives its lifecycle via [connector.Connector.ActivateSubscription] and [connector.Connector.DeactivateSubscription].

func Method ¶ added in v1.27.0

func Method(method string) Option

Method overrides the default "ANY" method for a Listen subscription. Accepts one of the recognized HTTP methods (GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH) or "ANY" to match any method. Matching is case-insensitive; the value is normalized to uppercase. Returns an error at option-application time if the method is not recognized.

func NoQueue ¶

func NoQueue() Option

NoQueue sets no queue for this subscription. Requests will be not be load-balanced, all instances of this microservice will receive the request

func NoTrace ¶ added in v1.28.0

func NoTrace() Option

NoTrace suppresses OpenTelemetry span creation for this subscription. Requests handled by this subscription will not appear in distributed traces. Useful for high-frequency or internal subscriptions that would otherwise add noise to traces.

func Queue ¶

func Queue(queue string) Option

Queue names the queue of the subscription. Requests will be load-balanced among all consumers with the same queue name

func RequiredClaims ¶ added in v1.22.0

func RequiredClaims(boolExp string) Option

RequiredClaims requires that the properties of the actor associated with the request satisfy the boolean expression. For example: iss=='my_issuer' && (roles.admin || roles.manager) && region=="US". The =~ and !~ operators evaluate the left operand against a regexp. String constants, including regexp patterns, must be quoted using single quotes, double quotes or backticks. A request that doesn't satisfy the constraint is denied with a 403 forbidden error.

func Route ¶ added in v1.27.0

func Route(route string) Option

Route overrides the default ":443/my-subscription" route for a Listen subscription. If the route does not include a hostname, it is resolved relative to the microservice's default hostname. If a port is not specified, 443 is used by default. Port 0 is used to designate any port. Path arguments are designated by curly braces.

Examples of valid routes:

(empty)
/
/path
:1080
:1080/
:1080/path
:0/any/port
/path/with/slash
path/with/no/slash
/section/{section}/page/{page...}
https://www.example.com/path
https://www.example.com:1080/path
//www.example.com:1080/path

func Tag ¶ added in v1.30.0

func Tag(tags ...string) Option

Tag attaches one or more free-form labels to the subscription. Tags are surfaced through [connector.Connector.Subscriptions] and let user code group related subscriptions for activation, deactivation, or other bulk operations. Tag names are not parsed by the framework; convention is short, lowercase, hyphen-or-dot-free identifiers (e.g. "python", "billing", "experimental"). Multiple calls accumulate; duplicates are preserved as written.

func Task ¶ added in v1.27.0

func Task(inputs any, outputs any) Option

Task declares the subscription as a workflow task endpoint. The inputs and outputs values are zero-value struct instances used for OpenAPI schema reflection.

func Trace ¶ added in v1.28.0

func Trace() Option

Trace clears the NoTrace flag, restoring the default behavior where each handled request creates an OpenTelemetry server span.

func Untag ¶ added in v1.30.0

func Untag(tags ...string) Option

Untag removes one or more tags previously attached with Tag. Tags not currently set are silently ignored. Provided for symmetry with Tag in programmatically composed option lists.

func Web ¶ added in v1.27.0

func Web() Option

Web declares the subscription as a raw HTTP web handler endpoint.

func Workflow ¶ added in v1.27.0

func Workflow(inputs any, outputs any) Option

Workflow declares the subscription as a workflow graph endpoint. The inputs and outputs values are zero-value struct instances used for OpenAPI schema reflection.

func NewSubscription ¶ added in v1.27.0

func NewSubscription(name string, defaultHost string, handler HTTPHandler, options ...Option) (*Subscription, error)

NewSubscription creates a new subscription registered by name. The name must be a legal Go-style upper-case identifier (e.g. "MyEndpoint2"). Exactly one feature option (Function, Web, InboundEvent, Task, [Graph]) must be supplied. Defaults filled in after options are applied:

• Method defaults to "ANY".
• Route defaults to ":<port>/<kebab-name>" with the port determined by the feature type (443 for function/web, 417 for inbound events, 428 for tasks/graphs).
• Queue defaults to defaultHost.