GetBuildAgent Class

Represents the activity that gets an IBuildAgent object.

Inheritance Hierarchy

System.Object
  System.Activities.Activity
    System.Activities.ActivityWithResult
      System.Activities.Activity<IBuildAgent>
        System.Activities.CodeActivity<IBuildAgent>
          Microsoft.TeamFoundation.Build.Workflow.Activities.GetBuildAgent

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

Syntax

'Declaración
<ToolboxBitmapAttribute(GetType(TeamBuildBaseActivityDesigner), "DefaultBuildIcon.png")> _
<BuildActivityAttribute(HostEnvironmentOption.Agent)> _
<BuildCategoryAttribute> _
Public NotInheritable Class GetBuildAgent _
    Inherits CodeActivity(Of IBuildAgent)

[ToolboxBitmapAttribute(typeof(TeamBuildBaseActivityDesigner), "DefaultBuildIcon.png")]
[BuildActivityAttribute(HostEnvironmentOption.Agent)]
[BuildCategoryAttribute]
public sealed class GetBuildAgent : CodeActivity<IBuildAgent>

[ToolboxBitmapAttribute(typeof(TeamBuildBaseActivityDesigner), L"DefaultBuildIcon.png")]
[BuildActivityAttribute(HostEnvironmentOption::Agent)]
[BuildCategoryAttribute]
public ref class GetBuildAgent sealed : public CodeActivity<IBuildAgent^>

[<Sealed>]
[<ToolboxBitmapAttribute(typeof(TeamBuildBaseActivityDesigner), "DefaultBuildIcon.png")>]
[<BuildActivityAttribute(HostEnvironmentOption.Agent)>]
[<BuildCategoryAttribute>]
type GetBuildAgent =  
    class
        inherit CodeActivity<IBuildAgent>
    end

public final class GetBuildAgent extends CodeActivity<IBuildAgent>

The GetBuildAgent type exposes the following members.

Constructors

	Name	Description
	GetBuildAgent	Initializes a new instance of the GetBuildAgent class.

Top

Properties

	Name	Description
	CacheId	Gets the identifier of the cache that is unique within the scope of the workflow definition. (Inherited from Activity.)
	Constraints	Gets a collection of Constraint activities that can be configured to provide validation for the Activity. (Inherited from Activity.)
	DisplayName	Gets or sets an optional friendly name that is used for debugging, validation, exception handling, and tracking. (Inherited from Activity.)
	Id	Gets an identifier that is unique in the scope of the workflow definition. (Inherited from Activity.)
	Implementation	Not supported. (Inherited from CodeActivity<IBuildAgent>.)
	Result	Gets or sets the result argument for the Activity<TResult>. (Inherited from Activity<IBuildAgent>.)
	ResultType	When implemented in a derived class, gets the type of an activity OutArgument. (Inherited from ActivityWithResult.)

Top

Methods

	Name	Description
	CacheMetadata(ActivityMetadata)	Not implemented. Use CacheMetadata(CodeActivityMetadata) instead. (Inherited from CodeActivity<IBuildAgent>.)
	CacheMetadata(CodeActivityMetadata)	Creates and validates a description of the activity’s arguments, variables, child activities, and activity delegates. (Inherited from CodeActivity<IBuildAgent>.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute	When implemented in a derived class, performs the execution of the activity. (Inherited from CodeActivity<IBuildAgent>.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (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.)
	ShouldSerializeDisplayName	Indicates whether the DisplayName property should be serialized. (Inherited from Activity.)
	ToString	Returns a String that contains the Id and DisplayName of the Activity. (Inherited from Activity.)

Top

Remarks

This activity can only be used within an AgentScope activity.

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