TransferJobsTask Class

Definition

Namespace:

Microsoft.SqlServer.Dts.Tasks.TransferJobsTask

Assembly:

Microsoft.SqlServer.TransferJobsTask.dll

Provides the methods and properties to transfer SQL Server Agent jobs from one instance of SQL Server to another.

public ref class TransferJobsTask sealed : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist, Microsoft::SqlServer::Dts::Tasks::TransferJobsTask::ITransferJobsTask

[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.transferjobstask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.TransferJobsTask.Localized), SamplesTag="SsisTransferJobsTask", TaskContact="Transfer Jobs Task; Microsoft Corporation; SQL Server 2019; (c) Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.TransferJobsTaskUI.TransferJobsTaskUI, Microsoft.SqlServer.TransferJobsTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("2DFF48BB-FD65-4AED-B3A8-6A3E2011EE8F")]
public sealed class TransferJobsTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.TransferJobsTask.ITransferJobsTask

[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.transferjobstask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.TransferJobsTask.Localized), SamplesTag="SsisTransferJobsTask", TaskContact="Transfer Jobs Task; Microsoft Corporation; SQL Server 2019; (c) Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.TransferJobsTaskUI.TransferJobsTaskUI, Microsoft.SqlServer.TransferJobsTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("2DFF48BB-FD65-4AED-B3A8-6A3E2011EE8F")>]
type TransferJobsTask = class
    inherit Task
    interface ITransferJobsTask
    interface IDTSBreakpointSite
    interface IDTSSuspend
    interface IDTSComponentPersist

Public NotInheritable Class TransferJobsTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist, ITransferJobsTask

Inheritance

Object

DtsObject

Task

TransferJobsTask

Attributes

DtsTaskAttribute GuidAttribute

Implements

IDTSBreakpointSite IDTSComponentPersist IDTSSuspend ITransferJobsTask

Constructors

TransferJobsTask()

Initializes a new instance of the TransferJobsTask class.

Properties

DebugMode	Gets or sets a Boolean indicating whether a task should determine whether breakpoints are enabled.
DestinationConnection	Gets or sets a String containing the name of the SMO connection manager for the destination database.
EnableJobsAtDestination	Gets or sets a Boolean indicating whether the jobs created at the destination should be enabled.
ExecutionValue	Returns an object containing the number of jobs transfered.
IfObjectExists	Gets or sets a value from the IfObjectExists enumeration indicating indicating if the task should fail, overwrite the existing job, or skip the transfer of the job if a job with the same name exists at the destination.
JobsList	Gets or sets a StringCollection containing the names of the jobs to transfer.
SourceConnection	Gets or sets a String containing the name of the SMO connection manager for the source database.
SuspendRequired	Gets or sets a Boolean indicating whether tasks should suspend when they encounter a breakpoint. This value is set by the run-time engine for tasks and containers when a breakpoint is encountered.
TargetServerVersion	(Inherited from Task)
TransferAllJobs	Gets or sets a Boolean indicating if some or all jobs are transferred.
Version	*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only. (Inherited from Task)

Methods

AcceptBreakpointManager(BreakpointManager)	Called by the run-time engine when a task or container is created, and is passed a BreakpointManager to enable the task to create, remove, and check the status of breakpoints. This method is called by the runtime and is not used in code.
CanUpdate(String)	*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task)
Equals(Object)	Determines whether two object instances are equal. (Inherited from DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)	Runs the task.
GetConnectionID(Connections, String)	Gets a String containing the ID of the connection. (Inherited from Task)
GetConnectionName(Connections, String)	Gets a String containing the name of the connection. (Inherited from Task)
GetHashCode()	Returns the hash code for this instance. (Inherited from DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)	Initializes the properties associated with the task. This method is called by the runtime and is not used in code.
LoadFromXML(XmlElement, IDTSInfoEvents)	This method is not callable by your application code. To load a package saved as .xml, use the LoadPackage(String, IDTSEvents) method.
ResumeExecution()	Resumes execution of the task after pausing. The task or container is resumed by the run-time engine.
SaveToXML(XmlDocument, IDTSInfoEvents)	This method is not callable by your application code. To save a package as .xml, use the SaveToXml(String, Package, IDTSEvents) method.
SuspendExecution()	Indicates that the executable needs to suspend. This method is called by the run-time engine.
Update(String)	*** Member deprecated; see Remarks. ***   This method updates the old package XML with the new package XML if CanUpdate(String) is set to true. (Inherited from Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)	Verifies that the task is correctly configured.