Class Agent

Represents the Relativity agent object.

Inheritance
System.Object
Artifact
Agent
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Relativity.Testing.Framework.Models
Assembly: Relativity.Testing.Framework.dll
Syntax
public class Agent : Artifact

Fields

| Improve this Doc View Source

RunIntervalDefault

The default run interval.

Declaration
public const int RunIntervalDefault = 3600
Field Value
Type Description
System.Int32

Properties

| Improve this Doc View Source

AgentServer

Gets or sets the server where the agent is to be added.

Declaration
public NamedArtifact AgentServer { get; set; }
Property Value
Type Description
NamedArtifact
| Improve this Doc View Source

AgentType

Gets or sets the kind of job that the agent executes.

Declaration
public NamedArtifact AgentType { get; set; }
Property Value
Type Description
NamedArtifact
| Improve this Doc View Source

Enabled

Gets or sets a value indicating whether the enabled agent state.

Declaration
public bool Enabled { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

LoggingLevel

Gets or sets the value indicating the message type that the system logs in the Event Viewer.

Declaration
public AgentLoggingLevelType LoggingLevel { get; set; }
Property Value
Type Description
AgentLoggingLevelType
| Improve this Doc View Source

Message

Gets or sets the message for the agent. This property is only used for the response, so it will be ignored if you populate it as part of the request.

Declaration
public string Message { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Name

Gets or sets the agent name.

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

RunInterval

Gets or sets the number of seconds that the agent should wait before checking the database for available jobs.

Declaration
[FieldName("Run Interval (seconds)")]
public int RunInterval { get; set; }
Property Value
Type Description
System.Int32