Share via

SoapPayloadMethod Class

  • Article

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
Public method SoapPayloadMethod() Initializes a new instance of the SoapPayloadMethod class.
Public method SoapPayloadMethod(SoapPayload, String) Initializes a new instance of the SoapPayloadMethod class with the specified SOAP configuration settings and with the specified name.
Public method 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.
Public method SoapPayloadMethod(SoapPayload, String, String, String, String) Initializes a new instance of the SoapPayloadMethod class with the specified SOAP configuration, name, method, database and schema.
Public method 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
Public property IsSystemObject Gets a value that indicates whether the object is a system object.
Public property MethodLoginType Gets or sets the method login type for the SOAP payload.
Public property 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.
Public property Name Gets or sets the name of the object. (Inherited from NamedSmoObject.)
Public property Namespace Gets or sets the namespace of the SOAP method. (Inherited from SoapMethodObject.)
Public property Parent Gets or sets the SoapPayload object that is the parent of the SoapPayloadMethod object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property ResultFormat Gets or sets the result format, such as whether to return all results including information messages or rowsets only.
Public property SqlMethod Gets the name of stored procedure or user-defined function that is bound to the SOAP payload method.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Public method Alter Updates any SoapPayloadMethod object property changes on the instance of Microsoft SQL Server.
Public method Create Creates a SOAP payload method on the instance of SQL Server as defined by the SoapPayloadMethod object.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Removes the SOAP payload method from the SOAP payload settings.
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public method Refresh Refreshes the script name. (Inherited from ScriptNameObjectBase.)
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method 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.
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

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

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method 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.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method 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.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method 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.

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace