io.serverlessworkflow.api.events

Class EventRef

java.lang.Object

io.serverlessworkflow.api.events.EventRef

All Implemented Interfaces:

Serializable

public class EventRef
extends Object
implements Serializable

Event References

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EventRef.Invoke

Constructor Summary

Constructors

Constructor and Description
EventRef() No args constructor for use in serialization
EventRef(String triggerEventRef, String resultEventRef)

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getContextAttributes() Add additional extension context attributes to the produced event
String	getData() Expression which selects parts of the states data output to become the data of the produced event.
EventRef.Invoke	getInvoke() Specifies if the function should be invoked sync or async.
String	getResultEventRef() Reference to the unique name of a 'consumed' event definition (Required)
String	getResultEventTimeout() Maximum amount of time (ISO 8601 format) to wait for the result event.
String	getTriggerEventRef() Reference to the unique name of a 'produced' event definition (Required)
void	setContextAttributes(Map<String,String> contextAttributes) Add additional extension context attributes to the produced event
void	setData(String data) Expression which selects parts of the states data output to become the data of the produced event.
void	setInvoke(EventRef.Invoke invoke) Specifies if the function should be invoked sync or async.
void	setResultEventRef(String resultEventRef) Reference to the unique name of a 'consumed' event definition (Required)
void	setResultEventTimeout(String resultEventTimeout) Maximum amount of time (ISO 8601 format) to wait for the result event.
void	setTriggerEventRef(String triggerEventRef) Reference to the unique name of a 'produced' event definition (Required)
EventRef	withContextAttributes(Map<String,String> contextAttributes)
EventRef	withData(String data)
EventRef	withInvoke(EventRef.Invoke invoke)
EventRef	withResultEventRef(String resultEventRef)
EventRef	withResultEventTimeout(String resultEventTimeout)
EventRef	withTriggerEventRef(String triggerEventRef)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventRef

public EventRef()

No args constructor for use in serialization

EventRef

public EventRef(String triggerEventRef,
                String resultEventRef)

Parameters:

resultEventRef -

triggerEventRef -

Method Detail

getTriggerEventRef

public String getTriggerEventRef()

Reference to the unique name of a 'produced' event definition (Required)

setTriggerEventRef

public void setTriggerEventRef(String triggerEventRef)

Reference to the unique name of a 'produced' event definition (Required)

withTriggerEventRef

public EventRef withTriggerEventRef(String triggerEventRef)

getResultEventRef

public String getResultEventRef()

Reference to the unique name of a 'consumed' event definition (Required)

setResultEventRef

public void setResultEventRef(String resultEventRef)

Reference to the unique name of a 'consumed' event definition (Required)

withResultEventRef

public EventRef withResultEventRef(String resultEventRef)

getResultEventTimeout

public String getResultEventTimeout()

Maximum amount of time (ISO 8601 format) to wait for the result event. If not defined it should default to the actionExecutionTimeout

setResultEventTimeout

public void setResultEventTimeout(String resultEventTimeout)

Maximum amount of time (ISO 8601 format) to wait for the result event. If not defined it should default to the actionExecutionTimeout

withResultEventTimeout

public EventRef withResultEventTimeout(String resultEventTimeout)

getData

public String getData()

Expression which selects parts of the states data output to become the data of the produced event.

setData

public void setData(String data)

Expression which selects parts of the states data output to become the data of the produced event.

withData

public EventRef withData(String data)

getContextAttributes

public Map<String,String> getContextAttributes()

Add additional extension context attributes to the produced event

setContextAttributes

public void setContextAttributes(Map<String,String> contextAttributes)

Add additional extension context attributes to the produced event

withContextAttributes

public EventRef withContextAttributes(Map<String,String> contextAttributes)

getInvoke

public EventRef.Invoke getInvoke()

Specifies if the function should be invoked sync or async. Default is sync.

setInvoke

public void setInvoke(EventRef.Invoke invoke)

Specifies if the function should be invoked sync or async. Default is sync.

withInvoke

public EventRef withInvoke(EventRef.Invoke invoke)