Waiting for engine...
Skip to main content

EventStreamsTopic

No description

type EventStreamsTopic {
  name: ID!
  environment: Environment!
  persistent: Boolean!
  producerCount: Int
  subscriptionCount: Int
  subscriptions: [EventStreamsSubscription!]
  backlogCount: BigInteger
  backlogSize: BigInteger
  messageRateIn: Float
  messageRateOut: Float
  createdTime: DateTime
  producers: [EventStreamsProducer]
  description: String
  createdBy: String
  partitions: Int
  restProduceUrl: String!
  restProduceSingleMsgUrl: String!
}

Fields​

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

The name of the topic. It is unique within the environment

EventStreamsTopic.environment ● Environment! non-null object platform {#environment}

The environment to which the topic belongs

EventStreamsTopic.persistent ● Boolean! non-null scalar miscellaneous {#persistent}

Whether the topic is persistent or not

EventStreamsTopic.producerCount ● Int scalar miscellaneous {#producer-count}

The current number of active producers on this topic

EventStreamsTopic.subscriptionCount ● Int scalar miscellaneous {#subscription-count}

The current number of subscriptions on this topic

EventStreamsTopic.subscriptions ● [EventStreamsSubscription!] list object event-streams-query {#subscriptions}

The list of subscriptions on this topic

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

The total number of messages for all subscriptions not acknowledged on this topic

EventStreamsTopic.backlogSize ● BigInteger scalar platform {#backlog-size}

The current backlog size for the topic, represented in bytes

EventStreamsTopic.messageRateIn ● Float scalar miscellaneous {#message-rate-in}

The current rate of messages consumed per second from this subscription

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

The current rate of messages consumed per second from this subscription

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

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

EventStreamsTopic.producers ● [EventStreamsProducer] list object event-streams-admin {#producers}

The list of all local publishers on the topic, ranging from zero to thousands

EventStreamsTopic.description ● String scalar miscellaneous {#description}

The user specified description for this topic

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

The user who created this topic

EventStreamsTopic.partitions ● Int scalar miscellaneous {#partitions}

The number of partitions for this topic

EventStreamsTopic.restProduceUrl ● String! non-null scalar miscellaneous {#rest-produce-url}

The Rest API URL that is used for producing messages on this topic

EventStreamsTopic.restProduceSingleMsgUrl ● String! non-null scalar miscellaneous {#rest-produce-single-msg-url}

The Rest API URL that is used for producing a single message on this topic

Returned By​

eventStreamsTopic query ●  eventStreamsTopicCreate mutation ●  eventStreamsTopics query ●  eventStreamsTopicUpdate mutation

Member Of​

EventStreamsEnvironment object ●  EventStreamsSubscription object ●  EventStreamsTopicMetrics object

Implemented By​

_Entity union

On this Page