Package com.tailf.notif

Class ProgressNotification

Object

com.tailf.notif.Notification

com.tailf.notif.ProgressNotification

Direct Known Subclasses:

CommitProgressNotification

public class ProgressNotification
extends Notification

Data structure for progress notifications.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ProgressNotification.ProgressEventType	Progress event type.

Constructor Summary

Constructors

Constructor	Description
ProgressNotification(NotificationType type, ProgressNotification.ProgressEventType progressEventType, Long timestamp, Long duration, String traceId, String spanId, String parentSpanId, int usid, int tid, int datastore, String context, String subsystem, String message, String annotation, Map<String,ProgressAttributeValue> attributes, List<ProgressLink> links)

Method Summary

Modifier and Type	Method	Description
String	getAnnotation()	Metadata about the event, indicating error, explains latency or show result etc.
Map<String,ProgressAttributeValue>	getAttributes()	Attributes of the event.
ProgressAttributeValue	getAttributeValue(String name)	Get a specific attribute of the event.
String	getContext()	The context is either one of netconf, cli, webui, snmp, rest, system or it can be any other context string defined through the use of MAAPI.
int	getDatastore()	Name of the datastore for which the transaction is started: Conf.DB_NONE Conf.DB_CANDIDATE Conf.DB_RUNNING Conf.DB_STARTUP Conf.DB_OPERATIONAL Conf.DB_PRE_COMMIT_RUNNING Conf.DB_INTENDED
String	getDatastoreStr()	Name, as string, of the datastore for which the transaction is started.
Long	getDuration()	Duration of the event in microseconds.
List<ProgressLink>	getLinks()	Links to other events.
String	getMessage()	Progress event messeage.
String	getParentSpanId()	This indicates the id of the parent span.
ProgressNotification.ProgressEventType	getProgressEventType()	Progress event type.
int	getSessionId()	User session id.
String	getSpanId()	Indicates the id of the span.
String	getSubsystem()	Subsystem name.
Long	getTimestamp()	Timestamp in microseconds since Epoch.
String	getTraceId()	Per request unique trace id, included in headers and entries for relevant logs.
int	getTransactionId()	Transaction id.
String	toString()

Methods inherited from class com.tailf.notif.Notification

getNotificationType

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ProgressNotification

public ProgressNotification(NotificationType type,
 ProgressNotification.ProgressEventType progressEventType,
 Long timestamp,
 Long duration,
 String traceId,
 String spanId,
 String parentSpanId,
 int usid,
 int tid,
 int datastore,
 String context,
 String subsystem,
 String message,
 String annotation,
 Map<String,ProgressAttributeValue> attributes,
 List<ProgressLink> links)

Method Details

toString

public String toString()

Overrides:

toString in class Notification

getProgressEventType

public ProgressNotification.ProgressEventType getProgressEventType()

Progress event type.

getTimestamp

public Long getTimestamp()

Timestamp in microseconds since Epoch. Depending on the progress event type, this timestamp indicates the start of the event, the end of the event, or just when the event occured.

getDuration

public Long getDuration()

Duration of the event in microseconds. Generated at the end of an event. The timestamp subtracted with the duration equals the start of the event.

getTraceId

public String getTraceId()

Per request unique trace id, included in headers and entries for relevant logs.

getSpanId

public String getSpanId()

Indicates the id of the span.

getParentSpanId

public String getParentSpanId()

This indicates the id of the parent span.

getSessionId

public int getSessionId()

User session id.

getTransactionId

public int getTransactionId()

Transaction id.

getDatastore

public int getDatastore()

Name of the datastore for which the transaction is started:

• Conf.DB_NONE
• Conf.DB_CANDIDATE
• Conf.DB_RUNNING
• Conf.DB_STARTUP
• Conf.DB_OPERATIONAL
• Conf.DB_PRE_COMMIT_RUNNING
• Conf.DB_INTENDED

getDatastoreStr

public String getDatastoreStr()

Name, as string, of the datastore for which the transaction is started.

getContext

public String getContext()

The context is either one of netconf, cli, webui, snmp, rest, system or it can be any other context string defined through the use of MAAPI.

getSubsystem

public String getSubsystem()

Subsystem name.

getMessage

public String getMessage()

Progress event messeage.

getAnnotation

public String getAnnotation()

Metadata about the event, indicating error, explains latency or show result etc.

getAttributes

public Map<String,ProgressAttributeValue> getAttributes()

Attributes of the event. The values can be of type ProgressAttributeLiteral or ProgressAttributeNumber.

getAttributeValue

public ProgressAttributeValue getAttributeValue(String name)

Get a specific attribute of the event. The value can be of type ProgressAttributeLiteral or ProgressAttributeNumber.

getLinks

public List<ProgressLink> getLinks()

Links to other events.