eventStreamsSubscriptionClearBacklog

Clears the specified subscription's backlog and returns its name

Description: This mutation removes all pending messages from the backlog of a given subscription without deleting the subscription itself.

Input:

• subscription: EventStreamsSubscriptionKey! — Identifies the subscription by topic and subscription name.

Example:

mutation {
eventStreamsSubscriptionClearBacklog(
subscription: {
topic: {
environmentId: "env-12345"
name: "orders-topic"
}
name: "orders-subscription"
}
)
}

eventStreamsSubscriptionClearBacklog(
  subscription: EventStreamsSubscriptionKey!
): ID!

Arguments

eventStreamsSubscriptionClearBacklog.subscription ● EventStreamsSubscriptionKey! non-null input event-streams-admin

Type

ID scalar miscellaneous

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.