Relativity.Testing.Framework.Api.Services.IAgentService

public interface IAgentService

Represents the [Agent](https://relativitydev.github.io/relativity.testing.framework/api/Relativity.Testing.Framework.Models.Agent.html) API service.

Documentation

Agent Create(Agent entity)

Creates the specified agent.

void Delete(int id)

Deletes the agent by ID.

Agent Get(int id)

Gets the agent by the specified ID.

AgentType GetAgentType(string name)

Gets agent type by specified name.

IEnumerable<Agent> GetAllAgents()

Gets all agents.

IEnumerable<Agent> GetAllAgentsForAgentType(string agentTypeName)

Gets all agents by specified agent type.

IEnumerable<AgentType> GetAllAgentTypes()

Gets all agent types.

IEnumerable<AgentServer> GetAvailableAgentServers(string agentTypeName)

Gets available agent servers for specified agent type.

Agent Require(Agent entity)

Requires the specified Agent(s). If Artifact.ArtifactID property of entity has positive value, gets entity by id and updates it.If Agent.AgentType property of entity exists, gets entity by type and updates it.Otherwise creates a new entity using ICreateStrategy<T>.

void Update(Agent entity)

Updates the specified Agent.