Package com.attivio.platform.store

Class DefaultConnectorExecutionRecord

java.lang.Object

com.attivio.platform.store.DefaultConnectorExecutionRecord

All Implemented Interfaces:

ConnectorExecutionRecord, java.io.Serializable

public class DefaultConnectorExecutionRecord
extends java.lang.Object
implements ConnectorExecutionRecord

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultConnectorExecutionRecord()
DefaultConnectorExecutionRecord(java.lang.String name)

Method Summary

Modifier and Type	Method	Description
java.util.UUID	getClientId()
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.
java.util.List<java.lang.String>	getExtraRunInfo()
long	getFinishTime()
java.lang.String	getName()
long	getStartTime()
ConnectorExecutionStatus	getStatus()	Note, this method will return ConnectorExecutionStatus.NOT_RUNNING for all historical records.
long	getTimestamp()
java.lang.String	getWorkflow()
boolean	isExternal()	External connectors are controlled by 3rd party code and provide limited monitoring and control capability.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultConnectorExecutionRecord

public DefaultConnectorExecutionRecord()

DefaultConnectorExecutionRecord

public DefaultConnectorExecutionRecord(java.lang.String name)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface ConnectorExecutionRecord

Returns:

the connector name;

getClientId

public java.util.UUID getClientId()

Specified by:

getClientId in interface ConnectorExecutionRecord

Returns:

the client id associated with the execution of the connector

getStatus

public ConnectorExecutionStatus getStatus()

Note, this method will return ConnectorExecutionStatus.NOT_RUNNING for all historical records.

Specified by:

getStatus in interface ConnectorExecutionRecord

Returns:

the execution status for the connector.

getStartTime

public long getStartTime()

Specified by:

getStartTime in interface ConnectorExecutionRecord

Returns:

the time the connector started running or -1 if never started.

getFinishTime

public long getFinishTime()

Specified by:

getFinishTime in interface ConnectorExecutionRecord

Returns:

the time the connector finished, or -1 if never finished.

getDocumentsSent

public 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.

Specified by:

getDocumentsSent in interface ConnectorExecutionRecord

Returns:

the number of documents sent by the connector, or -1 if never set

getWorkflow

public java.lang.String getWorkflow()

Specified by:

getWorkflow in interface ConnectorExecutionRecord

Returns:

the workflow that was used for ingestion

getExtraRunInfo

public java.util.List<java.lang.String> getExtraRunInfo()

Specified by:

getExtraRunInfo in interface ConnectorExecutionRecord

Returns:

list of arbitrary metadata attached to this execution

isExternal

public boolean isExternal()

External connectors are controlled by 3rd party code and provide limited monitoring and control capability. External connectors implement the ConnectorMonitorScanner interface.

Specified by:

isExternal in interface ConnectorExecutionRecord

Returns:

true if the connector was executed externally.

getTimestamp

public long getTimestamp()

Specified by:

getTimestamp in interface ConnectorExecutionRecord

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.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object