SoapPayload Class

The SoapPayload object represents a SQL Server SOAP payload.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.EndpointPayload
        Microsoft.SqlServer.Management.Smo.SoapPayload

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
<SfcElementTypeAttribute("Soap")> _
Public NotInheritable Class SoapPayload _
    Inherits EndpointPayload
'Usage
Dim instance As SoapPayload

[SfcElementTypeAttribute("Soap")]
public sealed class SoapPayload : EndpointPayload

[SfcElementTypeAttribute(L"Soap")]
public ref class SoapPayload sealed : public EndpointPayload

[<SealedAttribute>]
[<SfcElementTypeAttribute("Soap")>]
type SoapPayload =  
    class 
        inherit EndpointPayload 
    end

public final class SoapPayload extends EndpointPayload

The SoapPayload type exposes the following members.

Properties

	Name	Description
	DefaultDatabase	Gets or sets the default database for the SOAP payload.
	DefaultNamespace	Gets or sets the default namespace for the SOAP payload.
	IsSessionEnabled	Gets or sets the Boolean property that specifies whether the SOAP session is enabled.
	IsSqlBatchesEnabled	Gets or sets the Boolean property that specifies whether ad-hoc queries are allowed using the sqlbatch method.
	IsSystemObject	Gets a Boolean specifying whether the object is a System Object.
	Parent	Gets or sets the Endpoint object that is the parent of the EndpointPayload object. (Inherited from EndpointPayload.)
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	SessionNeverTimesOut	Gets or sets the Boolean property that specifies whether the session never times out.
	SessionTimeout	Gets or sets the number of seconds a session must be inactive before it is stopped.
	SoapPayloadMethods	References a collection of SoapPayloadMethod objects. Each SoapPayloadMethod object represents a SOAP payload method.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
	WsdlGeneratorOption	Gets or sets the Web Services Description Language (WSDL) generator options.
	WsdlGeneratorProcedure	Gets or sets the Web Services Description Language (WSDL) procedure.
	XmlFormatOption	Gets or sets the XML format options.
	XsdSchemaOption	Gets or sets the XSD schema option, which specifies how results are returned from an inline XSD schema.

Top

Methods

	Name	Description
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Equals	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
	GetHashCode	(Inherited from Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetType	(Inherited from Object.)
	Initialize()	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	IsObjectInitialized	Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	Refresh	Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	ToString	Returns a string representing the Endpoint Payload object. (Inherited from EndpointPayload.)
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

	Name	Description
	PropertyChanged	Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

	Name	Description
	IAlienObject.Discover	Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Inherited from SqlSmoObject.)
	IAlienObject.GetParent	Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetUrn	Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Inherited from SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)

Top

Remarks

Thread Safety

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

Examples

Implementing Endpoints

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.SqlServer.Management.Smo Namespace