Waiting for engine...
Skip to main content

EventStreamsRoute

A message routing rule that filters and routes messages based on metadata properties

type EventStreamsRoute {
  environmentId: ID!
  name: ID!
  inputTopic: String!
  subscriptionName: String!
  defaultOutputTopic: String!
  filters: [EventStreamsRouteFilterGroup!]!
  status: EventStreamsRouteStatus!
  errorMessage: String
  messagesReceivedCount: BigInteger!
  messagesProcessedCount: BigInteger!
  totalRestarts: Int
  lastInvocationTime: DateTime
}

Fields​

EventStreamsRoute.environmentId ● ID! non-null scalar miscellaneous {#environment-id}

Environment this route belongs to

EventStreamsRoute.name ● ID! non-null scalar miscellaneous {#name}

Name of the route (unique within environment)

EventStreamsRoute.inputTopic ● String! non-null scalar miscellaneous {#input-topic}

Input topic to consume messages from

EventStreamsRoute.subscriptionName ● String! non-null scalar miscellaneous {#subscription-name}

Subscription name for consuming from the input topic

[<CodePill>EventStreamsRoute.defaultOutputTopic</CodePill>](#default-output-topic)<Bullet />[<CodePill>String!</CodePill>](/APIs/GraphQL/APIReference/types/miscellaneous/scalars/string.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/> <Badge class="badge badge--secondary " text="miscellaneous"/> \{#default-output-topic\}

Default output topic for messages that don't match any filters

[<CodePill>EventStreamsRoute.filters</CodePill>](#filters)<Bullet />[<CodePill>[EventStreamsRouteFilterGroup!]!</CodePill>](/APIs/GraphQL/APIReference/types/event-streams-admin/objects/event-streams-route-filter-group.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="object"/> <Badge class="badge badge--secondary " text="event-streams-admin"/> \{#filters\}

List of filter groups with their conditions and output topics

[<CodePill>EventStreamsRoute.status</CodePill>](#status)<Bullet />[<CodePill>EventStreamsRouteStatus!</CodePill>](/APIs/GraphQL/APIReference/types/event-streams-admin/enums/event-streams-route-status.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="enum"/> <Badge class="badge badge--secondary " text="event-streams-admin"/> \{#status\}

Current status of the route

[<CodePill>EventStreamsRoute.errorMessage</CodePill>](#error-message)<Bullet />[<CodePill>String</CodePill>](/APIs/GraphQL/APIReference/types/miscellaneous/scalars/string.mdx) <Badge class="badge badge--secondary " text="scalar"/> <Badge class="badge badge--secondary " text="miscellaneous"/> \{#error-message\}

Error message if status is ERROR

[<CodePill>EventStreamsRoute.messagesReceivedCount</CodePill>](#messages-received-count)<Bullet />[<CodePill>BigInteger!</CodePill>](/APIs/GraphQL/APIReference/types/platform/scalars/big-integer.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/> <Badge class="badge badge--secondary " text="platform"/> \{#messages-received-count\}

Total messages received by this route function

[<CodePill>EventStreamsRoute.messagesProcessedCount</CodePill>](#messages-processed-count)<Bullet />[<CodePill>BigInteger!</CodePill>](/APIs/GraphQL/APIReference/types/platform/scalars/big-integer.mdx) <Badge class="badge badge--secondary badge--non_null" text="non-null"/> <Badge class="badge badge--secondary " text="scalar"/> <Badge class="badge badge--secondary " text="platform"/> \{#messages-processed-count\}

Total messages successfully processed by this route function

[<CodePill>EventStreamsRoute.totalRestarts</CodePill>](#total-restarts)<Bullet />[<CodePill>Int</CodePill>](/APIs/GraphQL/APIReference/types/miscellaneous/scalars/int.mdx) <Badge class="badge badge--secondary " text="scalar"/> <Badge class="badge badge--secondary " text="miscellaneous"/> \{#total-restarts\}

Total restarts across all function instances. High values indicate instability (crash loops).

[<CodePill>EventStreamsRoute.lastInvocationTime</CodePill>](#last-invocation-time)<Bullet />[<CodePill>DateTime</CodePill>](/APIs/GraphQL/APIReference/types/platform/scalars/date-time.mdx) <Badge class="badge badge--secondary " text="scalar"/> <Badge class="badge badge--secondary " text="platform"/> \{#last-invocation-time\}

Timestamp of last message processed. Null if no messages have been processed yet.

### Returned By

[<CodePill>eventStreamsRoute</CodePill>](/APIs/GraphQL/APIReference/operations/event-streams-admin/queries/event-streams-route.mdx)  <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />
[<CodePill>eventStreamsRouteCreate</CodePill>](/APIs/GraphQL/APIReference/operations/event-streams-admin/mutations/event-streams-route-create.mdx)  <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />
[<CodePill>eventStreamsRoutes</CodePill>](/APIs/GraphQL/APIReference/operations/event-streams-admin/queries/event-streams-routes.mdx)  <Badge class="badge badge--secondary badge--relation" text="query"/><Bullet />
[<CodePill>eventStreamsRouteStart</CodePill>](/APIs/GraphQL/APIReference/operations/event-streams-admin/mutations/event-streams-route-start.mdx)  <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />
[<CodePill>eventStreamsRouteStop</CodePill>](/APIs/GraphQL/APIReference/operations/event-streams-admin/mutations/event-streams-route-stop.mdx)  <Badge class="badge badge--secondary badge--relation" text="mutation"/><Bullet />
[<CodePill>eventStreamsRouteUpdate</CodePill>](/APIs/GraphQL/APIReference/operations/event-streams-admin/mutations/event-streams-route-update.mdx)  <Badge class="badge badge--secondary badge--relation" text="mutation"/>

On this Page