Class RoutingRule

A routing rule.

Hierarchy (View Summary)

Entity<RoutingRuleData>
- RoutingRule

Index

Constructors

Properties

Accessors

action data expressionText id isActive isDeleted listenerId priority

Methods

delete reload reorder replace setActive

Constructors

constructor

new RoutingRule(options: EntityOptions<RoutingRuleData>): RoutingRule
Parameters
- options: EntityOptions<RoutingRuleData>
  The client, path, backing data, and delete state.
Returns RoutingRule
Inherited from Entity.constructor
- Defined in entity.ts:46

Properties

`Protected` `Readonly`client

client: AdminClient

The client used to issue requests for this entity.

`Protected` `Readonly`path

path: string

The client-relative path of this resource.

Accessors

action

get action(): RoutingRuleAction
The action taken on a match.

Returns RoutingRuleAction
- Defined in listeners/routing-rules.ts:156

data

get data(): D
The raw wire record backing this entity.

Returns D
Inherited from Entity.data
- Defined in entity.ts:58

expressionText

get expressionText(): string
The match expression.

Returns string
- Defined in listeners/routing-rules.ts:151

id

get id(): string
Rule identifier.

Returns string
- Defined in listeners/routing-rules.ts:136

isActive

get isActive(): boolean
Whether the rule is active.

Returns boolean
- Defined in listeners/routing-rules.ts:161

isDeleted

get isDeleted(): boolean
Whether this entity has been deleted through this instance.

Local state only; not authoritative server state.

Returns boolean
Inherited from Entity.isDeleted
- Defined in entity.ts:69

listenerId

get listenerId(): string
Owning listener identifier.

Returns string
- Defined in listeners/routing-rules.ts:141

priority

get priority(): number
Evaluation priority; lower runs first.

Returns number
- Defined in listeners/routing-rules.ts:146

Methods

delete

delete(): Promise<boolean>
Deletes this resource.

Idempotent per instance: once this instance has deleted the resource, further calls are a local no-op.

Returns Promise<boolean>
true once the resource has been deleted through this instance.

Throws
ApiException When the control plane returns a non-success status.
Inherited from Entity.delete
- Defined in entity.ts:84

reload

reload(options?: RequestOptions): Promise<RoutingRule>
Re-fetches this rule.
Parameters
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<RoutingRule>
A fresh snapshot.
- Defined in listeners/routing-rules.ts:173

reorder

reorder(priority: number, options?: RequestOptions): Promise<RoutingRule>
Reorders the rule.
Parameters
- priority: number
  The new priority.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<RoutingRule>
The updated rule.
- Defined in listeners/routing-rules.ts:223

replace

replace(
request: ReplaceRoutingRuleRequest,
options?: RequestOptions,
): Promise<RoutingRule>
Replaces the expression and action; the priority is unchanged.
Parameters
- request: ReplaceRoutingRuleRequest
  The new expression and action.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<RoutingRule>
The updated rule.
- Defined in listeners/routing-rules.ts:187

setActive

setActive(isActive: boolean, options?: RequestOptions): Promise<RoutingRule>
Activates or deactivates the rule.
Parameters
- isActive: boolean
  Whether the rule should be active.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<RoutingRule>
The updated rule.
- Defined in listeners/routing-rules.ts:207