AgentBase
Describes basic properties, methods and events related to agent instances.
Read-only property returning unique ID of an agent.
Read-only property returning assembly path.
Read-only property returning class name.
Gets and sets the flag to mark an agent instance as enabled or disabled.
Read-only property returning Boolean flag indicating whether agent is currently executing.
Gets the Relativity.API.IAgentHelper object
Read-only property returning double number indicating the interval at which the agent instance runs.
Get whether the agent is healthy to do work
Read-only property returning time when agent instance last checked its execution.
Read-only property returning last message logged by agent instance.
Gets and sets logging level of an agent instance.
Read-only property which is overridden in a derived class.
Gets or sets the URL to the nearest Services API endpoint
Records the current time of the agent execution.
When true, this means the agent is marked for removal, and will not take any new jobs. Note that this value should never be set to false.
Sets an agent instance to check in on a fixed time interval.
Raised when agent instance changes its status to Disabled.
Raised when agent instance changes its status to Enabled.
Raised when agent instance experiences an exception while executing.
Raised when agent instance starts executing.
Raised when agent instance stops executing.
Raised when agent instance attempts to log message.
public AgentBase()
Instantiates an object of AgentBase type.
Sub which is overridden in a derived class.
Gets the workspace server.
Returns database connection based on the workspace ID passed in as a parameter.
Returns an IEnumerable<T> containing all ResourceGroupIDs this agent is a part of.
Returns whether the current time is between two specified DateTime times.
Indicates whether the current time is during the off hours for an agent.
Calls Dispose() on timer object and releases its resources.
Raises an error during agent execution.
Raises a message during agent execution.
Raises a message during agent execution but does not log to Relativity.Logging framework.
Raises a warning during agent execution.
Raises a warning during agent execution.
Sets the run interval of an agent instance.