Class ExternalEventContext
-
- All Implemented Interfaces:
-
java.io.Externalizable
,java.io.Serializable
,java.lang.Comparable
,org.apache.avro.generic.GenericContainer
,org.apache.avro.generic.GenericRecord
,org.apache.avro.generic.IndexedRecord
,org.apache.avro.specific.SpecificRecord
public class ExternalEventContext extends SpecificRecordBase implements SpecificRecord
The context of an external event. To be included in the payloads sent as part of the external event structure. Used to extract request information on the responding side.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public class
ExternalEventContext.Builder
RecordBuilder for ExternalEventContext instances.
-
Field Summary
Fields Modifier and Type Field Description public final static Schema
SCHEMA$
public String
requestId
public String
flowId
public KeyValuePairList
contextProperties
-
Constructor Summary
Constructors Constructor Description ExternalEventContext()
Default constructor. ExternalEventContext(String requestId, String flowId, KeyValuePairList contextProperties)
All-args constructor.
-
Method Summary
Modifier and Type Method Description String
getRequestId()
Gets the value of the 'requestId' field. void
setRequestId(String value)
Sets the value of the 'requestId' field. String
getFlowId()
Gets the value of the 'flowId' field. void
setFlowId(String value)
Sets the value of the 'flowId' field. KeyValuePairList
getContextProperties()
Gets the value of the 'contextProperties' field. void
setContextProperties(KeyValuePairList value)
Sets the value of the 'contextProperties' field. static Schema
getClassSchema()
static BinaryMessageEncoder<ExternalEventContext>
getEncoder()
Return the BinaryMessageEncoder instance used by this class. static BinaryMessageDecoder<ExternalEventContext>
getDecoder()
Return the BinaryMessageDecoder instance used by this class. static BinaryMessageDecoder<ExternalEventContext>
createDecoder(SchemaStore resolver)
Create a new BinaryMessageDecoder instance for this class that uses the specified SchemaStore. ByteBuffer
toByteBuffer()
Serializes this ExternalEventContext to a ByteBuffer. static ExternalEventContext
fromByteBuffer(ByteBuffer b)
Deserializes a ExternalEventContext from a ByteBuffer. SpecificData
getSpecificData()
Schema
getSchema()
Object
get(int field$)
void
put(int field$, Object value$)
static ExternalEventContext.Builder
newBuilder()
Creates a new ExternalEventContext RecordBuilder. static ExternalEventContext.Builder
newBuilder(ExternalEventContext.Builder other)
Creates a new ExternalEventContext RecordBuilder by copying an existing Builder. static ExternalEventContext.Builder
newBuilder(ExternalEventContext other)
Creates a new ExternalEventContext RecordBuilder by copying an existing ExternalEventContext instance. void
writeExternal(ObjectOutput out)
void
readExternal(ObjectInput in)
void
customEncode(Encoder out)
void
customDecode(ResolvingDecoder in)
-
Methods inherited from class org.apache.avro.specific.SpecificRecordBase
compareTo, equals, getConversion, hashCode, toString
-
Methods inherited from class org.apache.avro.generic.GenericRecord
hasField
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Constructor Detail
-
ExternalEventContext
ExternalEventContext()
Default constructor.
-
ExternalEventContext
ExternalEventContext(String requestId, String flowId, KeyValuePairList contextProperties)
All-args constructor.- Parameters:
requestId
- The request id of the external event.flowId
- The flow id of flow to respond to.contextProperties
- The context properties of the issuing flow which the external processor can use as it wishes, for example to allow or disallow certain actions.
-
-
Method Detail
-
getRequestId
String getRequestId()
Gets the value of the 'requestId' field.
-
setRequestId
void setRequestId(String value)
Sets the value of the 'requestId' field. The request id of the external event. Used for deduplication when processing responses.
- Parameters:
value
- the value to set.
-
setFlowId
void setFlowId(String value)
Sets the value of the 'flowId' field. The flow id of flow to respond to.
- Parameters:
value
- the value to set.
-
getContextProperties
KeyValuePairList getContextProperties()
Gets the value of the 'contextProperties' field.
-
setContextProperties
void setContextProperties(KeyValuePairList value)
Sets the value of the 'contextProperties' field. The context properties of the issuing flow which the external processor can use as it wishes, for example to allow or disallow certain actions.
- Parameters:
value
- the value to set.
-
getClassSchema
static Schema getClassSchema()
-
getEncoder
static BinaryMessageEncoder<ExternalEventContext> getEncoder()
Return the BinaryMessageEncoder instance used by this class.
-
getDecoder
static BinaryMessageDecoder<ExternalEventContext> getDecoder()
Return the BinaryMessageDecoder instance used by this class.
-
createDecoder
static BinaryMessageDecoder<ExternalEventContext> createDecoder(SchemaStore resolver)
Create a new BinaryMessageDecoder instance for this class that uses the specified SchemaStore.
- Parameters:
resolver
- a SchemaStore used to find schemas by fingerprint
-
toByteBuffer
ByteBuffer toByteBuffer()
Serializes this ExternalEventContext to a ByteBuffer.
-
fromByteBuffer
static ExternalEventContext fromByteBuffer(ByteBuffer b)
Deserializes a ExternalEventContext from a ByteBuffer.
- Parameters:
b
- a byte buffer holding serialized data for an instance of this class
-
getSpecificData
SpecificData getSpecificData()
-
getSchema
Schema getSchema()
-
newBuilder
static ExternalEventContext.Builder newBuilder()
Creates a new ExternalEventContext RecordBuilder.
-
newBuilder
static ExternalEventContext.Builder newBuilder(ExternalEventContext.Builder other)
Creates a new ExternalEventContext RecordBuilder by copying an existing Builder.
- Parameters:
other
- The existing builder to copy.
-
newBuilder
static ExternalEventContext.Builder newBuilder(ExternalEventContext other)
Creates a new ExternalEventContext RecordBuilder by copying an existing ExternalEventContext instance.
- Parameters:
other
- The existing instance to copy.
-
writeExternal
void writeExternal(ObjectOutput out)
-
readExternal
void readExternal(ObjectInput in)
-
customEncode
void customEncode(Encoder out)
-
customDecode
void customDecode(ResolvingDecoder in)
-
-
-
-