Waiting for engine...
Skip to main content

EventStreamsSubscription

No description

type EventStreamsSubscription {
name: ID!
topic: EventStreamsTopic!
type: EventStreamsSubscriptionType
durable: Boolean
backlogCount: BigInteger
messageRateOut: Float
createdTime: DateTime
createdBy: String
activeConsumerCount: BigInteger
consumers: [EventStreamsConsumer]
description: String
deadLetterBacklogCount: BigInteger
retryBacklogCount: BigInteger
restConsumeUrl: String!
restBatchConsumeUrl: String!
}

Fields

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

The name of the subscription. Unique within the topic

EventStreamsSubscription.topic ● EventStreamsTopic! non-null object event-streams-query {#topic}

The topic details the subscription is on

EventStreamsSubscription.type ● EventStreamsSubscriptionType enum event-streams-admin {#type}

The subscription type

EventStreamsSubscription.durable ● Boolean scalar miscellaneous {#durable}

Whether the subscription is durable or not

EventStreamsSubscription.backlogCount ● BigInteger scalar platform {#backlog-count}

The current number of messages not acknowledged on this subscription

EventStreamsSubscription.messageRateOut ● Float scalar miscellaneous {#message-rate-out}

The current rate of messages consumed per second from this subscription

EventStreamsSubscription.createdTime ● DateTime scalar platform {#created-time}

The timestamp when this subscription was created either through this api or when the first subscriber connected to it

EventStreamsSubscription.createdBy ● String scalar miscellaneous {#created-by}

The user who created this subscription

EventStreamsSubscription.activeConsumerCount ● BigInteger scalar platform {#active-consumer-count}

The current number of active consumers

EventStreamsSubscription.consumers ● [EventStreamsConsumer] list object event-streams-admin {#consumers}

The list of connected consumers for this subscription

EventStreamsSubscription.description ● String scalar miscellaneous {#description}

The user defined description for this subscription

EventStreamsSubscription.deadLetterBacklogCount ● BigInteger scalar platform {#dead-letter-backlog-count}

The current number of dead letter messages on this subscription

EventStreamsSubscription.retryBacklogCount ● BigInteger scalar platform {#retry-backlog-count}

The current number messages that are being retried on this subscription

EventStreamsSubscription.restConsumeUrl ● String! non-null scalar miscellaneous {#rest-consume-url}

The Rest API URL that is used for consuming a single message from this subscription

EventStreamsSubscription.restBatchConsumeUrl ● String! non-null scalar miscellaneous {#rest-batch-consume-url}

The Rest API URL that is used for consuming a batch of messages from this subscription

Returned By

eventStreamsSubscriptionCreate mutation ●  eventStreamsSubscriptionUpdate mutation

Member Of

EventStreamsSubscriptionMetrics object ●  EventStreamsTopic object

Implemented By

_Entity union

On this Page