AgentSettings Class

Represents the settings of a build agent.

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.Build.Workflow.Activities.AgentSettings

Namespace:  Microsoft.TeamFoundation.Build.Workflow.Activities
Assembly:  Microsoft.TeamFoundation.Build.Workflow (in Microsoft.TeamFoundation.Build.Workflow.dll)

Syntax

'Declaration
<SerializableAttribute> _
Public Class AgentSettings

[SerializableAttribute]
public class AgentSettings

[SerializableAttribute]
public ref class AgentSettings

[<SerializableAttribute>]
type AgentSettings =  class end

public class AgentSettings

The AgentSettings type exposes the following members.

Constructors

	Name	Description
	AgentSettings()	Initializes a new instance of the AgentSettings class.
	AgentSettings(TimeSpan, TimeSpan)	Initializes a new instance of the AgentSettings class.

Top

Properties

	Name	Description
	HasTags	Gets a flag describing whether this agent has tags set in Tags.
	IsMaxExecutionTimeSet	Gets a flag describing whether MaxExecutionTime is set.
	IsMaxWaitTimeSet	Gets a flag describing whether MaxWaitTime is set.
	MaxExecutionTime	Gets a TimeSpan object describing the maximum amount of time to allow the build agent to complete its activities.
	MaxWaitTime	Gets a TimeSpan object describing the maximum amount of time to wait for a build agent to become available.
	Name	Gets or sets the name of this build agent.
	TagComparison	Gets or sets the TagComparison value that describes how tags should be compared for a match.
	Tags	Gets or sets a StringList containing the tags associated with this agent.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetAgentReservationSpec	Creates an AgentReservationSpec object based on this agent’s Name and Tags properties.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.TeamFoundation.Build.Workflow.Activities Namespace