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

    • 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 status
        initiatorType - The type of initiator that started the flow
        flowId - The unique flow ID
        flowClassName - The fully qualified class name of the flow
        flowStatus - The current processing status of a flow
        result - 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • setCreatedTimestamp

         void setCreatedTimestamp(Instant value)

        Sets the value of the 'createdTimestamp' field. The date the flow was created.

        Parameters:
        value - the value to set.
      • 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.
      • 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
      • 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
      • 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.