Describes basic properties, methods and events related to agent instances.
Inheritance Hierarchy
kCura.Agent.AgentBase
Namespace: kCura.Agent
Assembly: kCura.Agent (in kCura.Agent.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
The AgentBase type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | AgentBase |
Instantiates an object of AgentBase type.
|
Properties
| Name | Description | |
|---|---|---|
 | AgentID |
Read-only property returning unique ID of an agent.
|
| AssemblyPath |
Read-only property returning assembly path.
|
| ClassName |
Read-only property returning class name.
|
| Enabled |
Gets and sets the flag to mark an agent instance as enabled or disabled.
|
| Executing |
Read-only property returning Boolean flag indicating whether agent is currently executing.
|
| Helper |
Gets the Relativity.API.IAgentHelper object
|
| Interval |
Read-only property returning double number indicating the interval at which the agent instance runs.
|
| IsHealthy |
Get whether the agent is healthy to do work
|
| LastExecutionTime |
Read-only property returning time when agent instance last checked its execution.
|
| LastMessage |
Read-only property returning last message logged by agent instance.
|
| LoggingLevel |
Gets and sets logging level of an agent instance.
|
| Name |
Read-only property which is overridden in a derived class.
|
| ServicesAPIUri | Obsolete.
Gets or sets the URL to the nearest Services API endpoint
|
| ServiceType | |
| StartTime |
Records the current time of the agent execution.
|
| ToBeRemoved |
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.
|
| UseFixedInterval |
Sets an agent instance to check in on a fixed time interval.
|
Methods
| Name | Description | |
|---|---|---|
| Equals | (Inherited from Object.) |
| Execute |
Sub which is overridden in a derived class.
|
| GetDatabaseConnection | Obsolete.
Returns database connection based on the workspace ID passed in as a parameter.
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetResourceGroupIDs |
Returns an IEnumerable<T> containing all ResourceGroupIDs this agent is a part of.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| IsBetweenTimes |
Returns whether the current time is between two specified DateTime times.
|
| IsOffHours |
Indicates whether the current time is during the off hours for an agent.
|
| KillTimer |
Calls Dispose() on timer object and releases its resources.
|
| RaiseError |
Raises an error during agent execution.
|
| RaiseMessage |
Raises a message during agent execution.
|
| RaiseMessageNoLogging |
Raises a message during agent execution but does not log to Relativity.Logging framework.
|
| RaiseWarning(String) |
Raises a warning during agent execution.
|
| RaiseWarning(String, String) |
Raises a warning during agent execution.
|
| SetInterval |
Sets the run interval of an agent instance.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events
| Name | Description | |
|---|---|---|
 | OnAgentDisabled |
Raised when agent instance changes its status to Disabled.
|
| OnAgentEnable |
Raised when agent instance changes its status to Enabled.
|
| OnAgentException |
Raised when agent instance experiences an exception while executing.
|
| OnAgentExecuteBegin |
Raised when agent instance starts executing.
|
| OnAgentExecuteFinish |
Raised when agent instance stops executing.
|
| OnMessage |
Raised when agent instance attempts to log message.
|
See Also