Interface ConnectorExecutionRecord

  • All Superinterfaces:
    java.io.Serializable
    All Known Implementing Classes:
    DefaultConnectorExecutionRecord

    public interface ConnectorExecutionRecord
    extends java.io.Serializable
    Contains information associated with the single execution of a connector. A series of these records forms the history of the connector execution.
    • Method Detail

      • getName

        java.lang.String getName()
        Returns:
        the connector name;
      • getClientId

        java.util.UUID getClientId()
        Returns:
        the client id associated with the execution of the connector
      • getTimestamp

        long getTimestamp()
        Returns:
        the timestamp associated with this connector execution. The records for a full connector execution followed by incremental executions will all have the same timestamps.
      • getStartTime

        long getStartTime()
        Returns:
        the time the connector started running or -1 if never started.
      • getFinishTime

        long getFinishTime()
        Returns:
        the time the connector finished, or -1 if never finished.
      • getDocumentsSent

        long getDocumentsSent()
        Note, this value is updated periodically (5s by default) at runtime (not on every document sent) and is not guaranteed to be the latest value. To get the latest, most accurate value the Audit API should be used.
        Returns:
        the number of documents sent by the connector, or -1 if never set
      • getWorkflow

        java.lang.String getWorkflow()
        Returns:
        the workflow that was used for ingestion
      • getExtraRunInfo

        java.util.List<java.lang.String> getExtraRunInfo()
        Returns:
        list of arbitrary metadata attached to this execution
      • isExternal

        boolean isExternal()
        External connectors are controlled by 3rd party code and provide limited monitoring and control capability. External connectors implement the ConnectorMonitorScanner interface.
        Returns:
        true if the connector was executed externally.