Class FlowStatus
-
- 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 FlowStatus extends SpecificRecordBase implements SpecificRecord
The Flow Status represents the current processing state of a flow at a given point in time
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public class
FlowStatus.Builder
RecordBuilder for FlowStatus instances.
-
Field Summary
Fields Modifier and Type Field Description public final static Schema
SCHEMA$
public FlowKey
key
public FlowInitiatorType
initiatorType
public String
flowId
public String
flowClassName
public FlowStates
flowStatus
public String
result
public ExceptionEnvelope
error
public String
processingTerminatedReason
public Instant
createdTimestamp
public Instant
lastUpdateTimestamp
-
Constructor Summary
Constructors Constructor Description FlowStatus()
Default constructor. FlowStatus(FlowKey key, FlowInitiatorType initiatorType, String flowId, String flowClassName, FlowStates flowStatus, String result, ExceptionEnvelope error, String processingTerminatedReason, Instant createdTimestamp, Instant lastUpdateTimestamp)
All-args constructor.
-
Method Summary
Modifier and Type Method Description FlowKey
getKey()
Gets the value of the 'key' field. void
setKey(FlowKey value)
Sets the value of the 'key' field. FlowInitiatorType
getInitiatorType()
Gets the value of the 'initiatorType' field. void
setInitiatorType(FlowInitiatorType value)
Sets the value of the 'initiatorType' field. String
getFlowId()
Gets the value of the 'flowId' field. void
setFlowId(String value)
Sets the value of the 'flowId' field. String
getFlowClassName()
Gets the value of the 'flowClassName' field. void
setFlowClassName(String value)
Sets the value of the 'flowClassName' field. FlowStates
getFlowStatus()
Gets the value of the 'flowStatus' field. void
setFlowStatus(FlowStates value)
Sets the value of the 'flowStatus' field. String
getResult()
Gets the value of the 'result' field. void
setResult(String value)
Sets the value of the 'result' field. ExceptionEnvelope
getError()
Gets the value of the 'error' field. void
setError(ExceptionEnvelope value)
Sets the value of the 'error' field. String
getProcessingTerminatedReason()
Gets the value of the 'processingTerminatedReason' field. void
setProcessingTerminatedReason(String value)
Sets the value of the 'processingTerminatedReason' field. Instant
getCreatedTimestamp()
Gets the value of the 'createdTimestamp' field. void
setCreatedTimestamp(Instant value)
Sets the value of the 'createdTimestamp' field. Instant
getLastUpdateTimestamp()
Gets the value of the 'lastUpdateTimestamp' field. void
setLastUpdateTimestamp(Instant value)
Sets the value of the 'lastUpdateTimestamp' field. static Schema
getClassSchema()
static BinaryMessageEncoder<FlowStatus>
getEncoder()
Return the BinaryMessageEncoder instance used by this class. static BinaryMessageDecoder<FlowStatus>
getDecoder()
Return the BinaryMessageDecoder instance used by this class. static BinaryMessageDecoder<FlowStatus>
createDecoder(SchemaStore resolver)
Create a new BinaryMessageDecoder instance for this class that uses the specified SchemaStore. ByteBuffer
toByteBuffer()
Serializes this FlowStatus to a ByteBuffer. static FlowStatus
fromByteBuffer(ByteBuffer b)
Deserializes a FlowStatus from a ByteBuffer. SpecificData
getSpecificData()
Schema
getSchema()
Object
get(int field$)
Conversion<out Object>
getConversion(int field)
void
put(int field$, Object value$)
static FlowStatus.Builder
newBuilder()
Creates a new FlowStatus RecordBuilder. static FlowStatus.Builder
newBuilder(FlowStatus.Builder other)
Creates a new FlowStatus RecordBuilder by copying an existing Builder. static FlowStatus.Builder
newBuilder(FlowStatus other)
Creates a new FlowStatus RecordBuilder by copying an existing FlowStatus instance. void
writeExternal(ObjectOutput out)
void
readExternal(ObjectInput in)
-
Methods inherited from class org.apache.avro.specific.SpecificRecordBase
compareTo, customDecode, customEncode, equals, 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
-
FlowStatus
FlowStatus()
Default constructor.
-
FlowStatus
FlowStatus(FlowKey key, FlowInitiatorType initiatorType, String flowId, String flowClassName, FlowStates flowStatus, String result, ExceptionEnvelope error, String processingTerminatedReason, Instant createdTimestamp, Instant lastUpdateTimestamp)
All-args constructor.- Parameters:
key
- The unique ID for the statusinitiatorType
- The type of initiator that started the flowflowId
- The unique flow IDflowClassName
- The fully qualified class name of the flowflowStatus
- The current processing status of a flowresult
- Optional result, this contains the result from the flow will only be set if the flow status is 'COMPLETED'error
- Optional error message, this will be set if the flow status is 'FAILED'processingTerminatedReason
- Optional message indicating reasoning why processing a flow has been terminated.createdTimestamp
- The date the flow was created.lastUpdateTimestamp
- The date and time this status update was published.
-
-
Method Detail
-
setKey
void setKey(FlowKey value)
Sets the value of the 'key' field. The unique ID for the status
- Parameters:
value
- the value to set.
-
getInitiatorType
FlowInitiatorType getInitiatorType()
Gets the value of the 'initiatorType' field.
-
setInitiatorType
void setInitiatorType(FlowInitiatorType value)
Sets the value of the 'initiatorType' field. The type of initiator that started the flow
- Parameters:
value
- the value to set.
-
setFlowId
void setFlowId(String value)
Sets the value of the 'flowId' field. The unique flow ID
- Parameters:
value
- the value to set.
-
getFlowClassName
String getFlowClassName()
Gets the value of the 'flowClassName' field.
-
setFlowClassName
void setFlowClassName(String value)
Sets the value of the 'flowClassName' field. The fully qualified class name of the flow
- Parameters:
value
- the value to set.
-
getFlowStatus
FlowStates getFlowStatus()
Gets the value of the 'flowStatus' field.
-
setFlowStatus
void setFlowStatus(FlowStates value)
Sets the value of the 'flowStatus' field. The current processing status of a flow
- Parameters:
value
- the value to set.
-
setResult
void setResult(String value)
Sets the value of the 'result' field. Optional result, this contains the result from the flow will only be set if the flow status is 'COMPLETED'
- Parameters:
value
- the value to set.
-
getError
ExceptionEnvelope getError()
Gets the value of the 'error' field.
-
setError
void setError(ExceptionEnvelope value)
Sets the value of the 'error' field. Optional error message, this will be set if the flow status is 'FAILED'
- Parameters:
value
- the value to set.
-
getProcessingTerminatedReason
String getProcessingTerminatedReason()
Gets the value of the 'processingTerminatedReason' field.
-
setProcessingTerminatedReason
void setProcessingTerminatedReason(String value)
Sets the value of the 'processingTerminatedReason' field. Optional message indicating reasoning why processing a flow has been terminated.
- Parameters:
value
- the value to set.
-
getCreatedTimestamp
Instant getCreatedTimestamp()
Gets the value of the 'createdTimestamp' field.
-
setCreatedTimestamp
void setCreatedTimestamp(Instant value)
Sets the value of the 'createdTimestamp' field. The date the flow was created.
- Parameters:
value
- the value to set.
-
getLastUpdateTimestamp
Instant getLastUpdateTimestamp()
Gets the value of the 'lastUpdateTimestamp' field.
-
setLastUpdateTimestamp
void setLastUpdateTimestamp(Instant value)
Sets the value of the 'lastUpdateTimestamp' field. The date and time this status update was published.
- Parameters:
value
- the value to set.
-
getClassSchema
static Schema getClassSchema()
-
getEncoder
static BinaryMessageEncoder<FlowStatus> getEncoder()
Return the BinaryMessageEncoder instance used by this class.
-
getDecoder
static BinaryMessageDecoder<FlowStatus> getDecoder()
Return the BinaryMessageDecoder instance used by this class.
-
createDecoder
static BinaryMessageDecoder<FlowStatus> 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 FlowStatus to a ByteBuffer.
-
fromByteBuffer
static FlowStatus fromByteBuffer(ByteBuffer b)
Deserializes a FlowStatus from a ByteBuffer.
- Parameters:
b
- a byte buffer holding serialized data for an instance of this class
-
getSpecificData
SpecificData getSpecificData()
-
getSchema
Schema getSchema()
-
getConversion
Conversion<out Object> getConversion(int field)
-
newBuilder
static FlowStatus.Builder newBuilder()
Creates a new FlowStatus RecordBuilder.
-
newBuilder
static FlowStatus.Builder newBuilder(FlowStatus.Builder other)
Creates a new FlowStatus RecordBuilder by copying an existing Builder.
- Parameters:
other
- The existing builder to copy.
-
newBuilder
static FlowStatus.Builder newBuilder(FlowStatus other)
Creates a new FlowStatus RecordBuilder by copying an existing FlowStatus instance.
- Parameters:
other
- The existing instance to copy.
-
writeExternal
void writeExternal(ObjectOutput out)
-
readExternal
void readExternal(ObjectInput in)
-
-
-
-