public interface Event
Represents an event that is published by a producer and received by a consumer. A consumer indicates interest in receiving events by subscribing for events.
An event is identified by a type. Event types are grouped into event families.EventProducer
,
EventingService
,
EventSubscriptionAttributes
,
EventFilter
,
EventMetaData
Modifier and Type | Method and Description |
---|---|
String |
getConsumerName()
The service name of the consumer.
|
Object |
getConsumerPrivateData()
This is an arbitrary, opaque object that a consumer can include as part
of its subscription.
|
String |
getConsumerVersion()
The version of the consumer.
|
String |
getEventId()
Get the event ID of the event, which is an arbitrary, unique identifier
of an event.
|
EventMetaData |
getEventMetaData()
Get the event meta data provided by the event producer.
|
String |
getFamily()
Get the family of the event.
|
String |
getPayload()
Get the event payload, which is an arbitrary set of data provided by a
producer as part of an event publication.
|
String |
getProducerName()
The name of the producer that published the event.
|
String |
getProducerVersion()
The version number of the producer that published the event.
|
long |
getPublicationTimestamp()
Returns the time from the epoch in milliseconds when the event was
published.
|
String |
getSubscriptionId()
The subscription ID of the subscription that resulted in this event being
delivered.
|
String |
getType()
Get the event type of the event.
|
String |
getTypeQualified()
Get fully qualified type formatted as "family:type"
|
String |
getVersion()
Get the version of the event.
|
String getFamily()
String getType()
String getTypeQualified()
String getPayload()
String getVersion()
String getEventId()
String getSubscriptionId()
String getProducerName()
String getProducerVersion()
String getConsumerName()
The service name of the consumer.
Consumers can subscribe on behalf of other consumers, and this method returns the value that was explicitly specified during the subscription. The returned value will be an empty string if no consumer name was specified in the subscription.String getConsumerVersion()
The version of the consumer.
Consumers can subscribe on behalf of other consumers, and this method returns the value that was explicitly specified during the subscription. The returned value will be an empty string if no consumer version was specified in the subscription.EventMetaData getEventMetaData()
Object getConsumerPrivateData()
long getPublicationTimestamp()
Copyright © 2023 Avaya. All rights reserved.