Class RoutingRulesClient

Routing rules for a single listener.

Rules are evaluated in ascending priority; lower runs first.

Index

Constructors

Methods

create get list

Constructors

constructor

new RoutingRulesClient(options: RoutingRulesClientOptions): RoutingRulesClient
Parameters
- options: RoutingRulesClientOptions
  The underlying admin client and rules path.
Returns RoutingRulesClient
- Defined in listeners/routing-rules.ts:65

Methods

create

create(
request: CreateRoutingRuleRequest,
options?: RequestOptions,
): Promise<RoutingRule>
Creates a routing rule.
Parameters
- request: CreateRoutingRuleRequest
  The priority, expression, and action.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<RoutingRule>
The created rule.

Throws
Error When a field fails local validation.
- Defined in listeners/routing-rules.ts:117

get

get(ruleId: string, options?: RequestOptions): Promise<RoutingRule>
Gets a routing rule by identifier.
Parameters
- ruleId: string
  The rule identifier.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<RoutingRule>
The hydrated rule.

Throws
NotFoundException When the rule is not visible.
- Defined in listeners/routing-rules.ts:101

list

list(options?: ListRoutingRulesOptions): Promise<Paged<RoutingRule>>
Lists routing rules with optional filters.
Parameters
- options: ListRoutingRulesOptions = {}
  Optional filters, pagination, and cancellation signal.
Returns Promise<Paged<RoutingRule>>
A lazily paginating collection of rules.

Throws
ApiException When the control plane returns a non-success status.
- Defined in listeners/routing-rules.ts:79