Exposes methods for creating, reading, updating, and deleting agents, as well as various helper methods.
Namespace: Relativity.Services.Interfaces.Agent
Assembly: Relativity.Services.Interfaces (in Relativity.Services.Interfaces.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
The IAgentManager type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | CreateAsync(Int32, AgentRequest) |
Adds a single agent to Relativity.
|
| CreateAsync(Int32, AgentRequest, Int32) |
Adds multiple copies of an agent to Relativity.
|
| DeleteAsync(Int32, Int32) |
Removes an agent after it finishes executing.
|
| DeleteAsync(Int32, Int32, Boolean) |
Removes an agent conditionally waiting for it to finish executing.
|
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) |
| GetAgentServersAsync |
Retrieves a list of all agent servers in a Relativity environment.
|
| GetAgentTypesAsync |
Retrieves a list of agent types.
|
| GetAvailableAgentServersAsync(Int32, Guid) |
Uses the GUID of a specific agent type to retrieve a list of compatible agent servers.
|
| GetAvailableAgentServersAsync(Int32, Int32) |
Uses the Artifact ID of a specific agent type to retrieve a list of compatible agent servers.
|
| ReadAsync(Int32, Int32) |
Retrieves basic metadata for an agent, including its name, type, interval, and other properties.
|
| ReadAsync(Int32, Int32, Boolean, Boolean) |
Retrieves extended metadata for an agent, including information about additional actions available.
|
| UpdateAsync(Int32, Int32, AgentRequest) |
Modifies the properties of an agent.
|
| UpdateAsync(Int32, Int32, AgentRequest, DateTime) |
Restricts updates to the properties of the agent to the date that it was last modified
|
| ValidateCreateInstanceLimitAsync |
Indicates whether adding a new agent exceeds the limits for the agent type in a Relativity environment or server.
|
| ValidateDeleteInstanceLimitAsync |
Indicates whether deleting an agent violates the lower limit for an agent type in a Relativity environment, resource pool, or server.
|
| ValidateUpdateInstanceLimitAsync |
Indicates whether modifying an agent violates the minimum or maximum limit for the agent type in a Relativity environment, resource pool, or server.
|
See Also