Share via


ServicingJobData Class

Inheritance Hierarchy

System.Object
  Microsoft.TeamFoundation.Framework.Server.ServicingJobData

Namespace:  Microsoft.TeamFoundation.Framework.Server
Assembly:  Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.dll)

Syntax

'Declaration
Public Class ServicingJobData
public class ServicingJobData
public ref class ServicingJobData
type ServicingJobData =  class end
public class ServicingJobData

The ServicingJobData type exposes the following members.

Constructors

  Name Description
Public method ServicingJobData()
Public method ServicingJobData(array<String[])

Top

Properties

  Name Description
Public property JobTitle This is a user friendly name for this job. It will be used as the name of the job when jobs are queued.
Public property OperationClass The [Operation] class defines the general class of this servicing operation.
Public property ServicingHostId A servicing request can specify the [InstanceId] of the host it will be servicing. This will allow the servicing engine to perform tasks regarding the servicing host.
Public property ServicingItems
Public property ServicingItemsValue Note: These should not be changed, they are the serialized form of the ServicingItems Dictionary.
Public property ServicingLocks The [LockMode] is used to define locking for specific job types.[LockMode] effects:[TeamFoundationLockMode.NoLock] - These locks will be ignored.[TeamFoundationLockMode.Shared] - This will cause the job to take a shared lock on this [ServicingLock]. Any other job taking a shared lock will be able to continue, but an exclusive lock will be blocked until you finish and you will not be able to start until the exclusive job finishes.[TeamFoundationLockMode.Exclusive] - This will cause the job to take an exclusive lock on this [ServicingLock]. This means that no other operations will be able to start after this lock is acquired. It will also wait for any running jobs that have a lock on one of these.
Public property ServicingOperations This is the set of [ServicingOperations] that must be run for this servicing job. They are executed in the order listed in the array. The operations are executed in a serialized manner, where the second operation will not start until the first operation finishes.
Public property ServicingOptions [ServicingOptions] are used to control the validation of the servicing job when the job is started. See the [ServicingFlags] enumeration for the available options.
Public property ServicingOptionsInt32
Public property ServicingTokens
Public property ServicingTokensValue Note: These should not be changed; they are the serialized form of the ServicingTokens Dictionary.

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method 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.Framework.Server Namespace