SoapPayloadMethod Class

The SoapPayloadMethod class represents a SOAP payload method for the referenced HTTP endpoint.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.SoapMethodObject
            Microsoft.SqlServer.Management.Smo.SoapPayloadMethod

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

Syntax

'Declaration
<SfcElementTypeAttribute("Method")> _
Public NotInheritable Class SoapPayloadMethod _
    Inherits SoapMethodObject _
    Implements ICreatable, IDroppable, IAlterable
'Usage
Dim instance As SoapPayloadMethod

[SfcElementTypeAttribute("Method")]
public sealed class SoapPayloadMethod : SoapMethodObject, 
    ICreatable, IDroppable, IAlterable

[SfcElementTypeAttribute(L"Method")]
public ref class SoapPayloadMethod sealed : public SoapMethodObject, 
    ICreatable, IDroppable, IAlterable

[<SealedAttribute>]
[<SfcElementTypeAttribute("Method")>]
type SoapPayloadMethod =  
    class 
        inherit SoapMethodObject 
        interface ICreatable 
        interface IDroppable 
        interface IAlterable 
    end

public final class SoapPayloadMethod extends SoapMethodObject implements ICreatable, IDroppable, IAlterable

The SoapPayloadMethod type exposes the following members.

Constructors

	Name	Description
	SoapPayloadMethod()	Initializes a new instance of the SoapPayloadMethod class.
	SoapPayloadMethod(SoapPayload, String)	Initializes a new instance of the SoapPayloadMethod class with the specified SOAP configuration settings and with the specified name.
	SoapPayloadMethod(SoapPayload, String, String)	Initializes a new instance of the SoapPayloadMethod class with the specified SOAP configuration settings, with the specified name, and specified method namespace.
	SoapPayloadMethod(SoapPayload, String, String, String, String)	Initializes a new instance of the SoapPayloadMethod class with the specified SOAP configuration, name, method, database and schema.
	SoapPayloadMethod(SoapPayload, String, String, String, String, String)	Initializes a new instance of the SoapPayloadMethod class with the specified SOAP configuration settings, name, database, schema method and method namespace.

Top

Properties

	Name	Description
	IsSystemObject	Gets a value that indicates whether the object is a system object.
	MethodLoginType	Gets or sets the method login type for the SOAP payload.
	MethodXsdSchemaOption	Gets or sets the method XSD schema option that specifies how the XSD schema for the method result is returned in the SOAP payload response.
	Name	Gets or sets the name of the object. (Inherited from NamedSmoObject.)
	Namespace	Gets or sets the namespace of the SOAP method. (Inherited from SoapMethodObject.)
	Parent	Gets or sets the SoapPayload object that is the parent of the SoapPayloadMethod object.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	ResultFormat	Gets or sets the result format, such as whether to return all results including information messages or rowsets only.
	SqlMethod	Gets the name of stored procedure or user-defined function that is bound to the 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.)

Top

Methods

	Name	Description
	Alter	Updates any SoapPayloadMethod object property changes on the instance of Microsoft SQL Server.
	Create	Creates a SOAP payload method on the instance of SQL Server as defined by the SoapPayloadMethod object.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Removes the SOAP payload method from the SOAP payload settings.
	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 script name. (Inherited from ScriptNameObjectBase.)
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	SetSqlMethod	Sets the database name, schema, and name of the stored procedure or user-defined function that is bound to the referenced SOAP payload method.
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	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

The SoapPayloadMethod object provides programmatic access to the SOAP payload bindings to stored procedures and user-defined functions.

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.

Share via