WebServiceTask Class

Definition

Runs a Web method and stores the result in a specified location. This class cannot be inherited.

public ref class WebServiceTask sealed : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist, Microsoft::SqlServer::Dts::Tasks::WebServiceTask::IDTSWebServiceTask
[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.webservicetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.WebServiceTask.WebServiceTaskMessages), SamplesTag="SsisWebServiceTask", TaskContact="Web Service Task; Microsoft Corporation; SQL Server 2016; © 2015 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.WebServiceTask.WebServiceTaskUI, Microsoft.SqlServer.WebServiceTaskUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class WebServiceTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.WebServiceTask.IDTSWebServiceTask
[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.webservicetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.WebServiceTask.WebServiceTaskMessages), SamplesTag="SsisWebServiceTask", TaskContact="Web Service Task; Microsoft Corporation; SQL Server 2017; © 2017 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.WebServiceTask.WebServiceTaskUI, Microsoft.SqlServer.WebServiceTaskUI, Version=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class WebServiceTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.WebServiceTask.IDTSWebServiceTask
[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.webservicetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.WebServiceTask.WebServiceTaskMessages), SamplesTag="SsisWebServiceTask", TaskContact="Web Service Task; Microsoft Corporation; SQL Server 2019; © 2019 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.WebServiceTask.WebServiceTaskUI, Microsoft.SqlServer.WebServiceTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class WebServiceTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.WebServiceTask.IDTSWebServiceTask
type WebServiceTask = class
    inherit Task
    interface IDTSComponentPersist
    interface IDTSWebServiceTask
    interface IDTSBreakpointSite
    interface IDTSSuspend
Public NotInheritable Class WebServiceTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist, IDTSWebServiceTask
Inheritance
WebServiceTask
Attributes
Implements

Remarks

Using the WebServiceTask class, the task designer can execute a Web method and store the results in a package variable or a file.

Constructors

WebServiceTask()

Initializes a new instance of the WebServiceTask class.

Properties

Connection

Gets or sets the name of the connection to use.

DebugMode

Gets or sets a Boolean that indicates if the task is in debug mode. The DebugMode property can be accessed by multiple threads at the same time. To ensure thread safety and avoid concurrency problems, the Interlocked class from the Microsoft .NET Framework is used.

ExecutionValue

Returns a user-defined object. This field is read-only.

(Inherited from Task)
OutputLocation

Gets or sets the output location of the results of the Web method.

OutputType

Gets or sets a value that indicates the storage location of the result of the Web method invocation.

OverwriteWsdlFile

Gets or sets a value that indicates if the Web Services Description Language (WDSL) file will be overwritten.

ServiceName

Gets or sets the name of the Web service.

SuspendRequired

Gets or sets a Boolean that indicates if tasks should suspend when they encounter a breakpoint. This value is set by the runtime engine for tasks and containers when a breakpoint is encountered.

TargetServerVersion (Inherited from Task)
Version

*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only.

(Inherited from Task)
WebMethodInfo

Gets or sets a DTSWebMethodInfo object.

WsdlFile

Gets or sets the name of a Web Services Description Language (WSDL) file that is to be read from either a file URL or an HTTP URL.

Methods

AcceptBreakpointManager(BreakpointManager)

Passes a BreakpointManager to the task. The task will use the breakpoint manager 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 web service 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 web service 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 runtime 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 runtime 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 web service component is properly configured.

Applies to