Represents the results of a read operation on an agent.
Inheritance Hierarchy
Relativity.Services.Interfaces.Shared.Models.ObjectIdentifier
Relativity.Services.Interfaces.Shared.Models.DisplayableObjectIdentifier
Relativity.Services.Interfaces.Agent.Models.AgentResponse
Namespace: Relativity.Services.Interfaces.Agent.Models
Assembly: Relativity.Services.Interfaces (in Relativity.Services.Interfaces.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
The AgentResponse type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | AgentResponse | Initializes a new instance of the AgentResponse class |
Properties
| Name | Description | |
|---|---|---|
 | Actions |
Gets a list of RESTful operations that a user has permissions to perform on the agent.
|
| AgentServer |
Gets the identifier for the server hosting the agent for a user with sufficient permissions.
|
| AgentType |
Gets the identifier for the agent type for a user with sufficient permissions.
|
| ArtifactID | (Inherited from ObjectIdentifier.) |
| CreatedBy |
Gets the Artifact ID and name of the user who created the agent.
|
| CreatedOn |
Gets the date and time when the agent was added to Relativity.
|
| DetailMessage |
Gets a comprehensive version of the message that the agent logged to Relativity.
|
| Enabled |
Gets a Boolean value indicating whether the agent is running.
|
| EventLevel |
Gets the event type of the last message that the agent logged to Relativity.
|
| Guids | (Inherited from ObjectIdentifier.) |
| Interval |
Gets the number of seconds that the agent should wait before checking the database for available jobs.
|
| Keywords |
Gets optional words or phrases used to describe the agent.
|
| LastModifiedBy |
Gets the Artifact ID and name of the user who recently updated the agent.
|
| LastModifiedOn |
Gets the date and time when the agent was most recently updated.
|
| LastUpdate |
Gets the date and time immediately before the most recent call to the execution method on the agent.
|
| LoggingLevel |
Gets a value indicating the message type that the system logs in the Event Viewer.
|
| Message |
Gets the most recent message that the agent logged to Relativity.
|
| MessageTime |
Gets the date and time when the agent last updated the Message property.
|
| Meta |
Gets a list of unsupported and read-only properties on the current Agent object.
|
| Name | (Inherited from DisplayableObjectIdentifier.) |
| Notes |
Gets optional words or phrase used to describe the agent.
|
Methods
| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also