ServiceClient Class

  • Article

Contains the various API operations for the service client to interact with Master Data Services.

Inheritance Hierarchy

System.Object
  System.ServiceModel.ClientBase<IService>
    Microsoft.MasterDataServices.ServiceClient

Namespace:  Microsoft.MasterDataServices
Assembly:  Microsoft.MasterDataServices (in Microsoft.MasterDataServices.dll)

Syntax

'Declaration
Public Class ServiceClient _
    Inherits ClientBase(Of IService) _
    Implements IService
'Usage
Dim instance As ServiceClient

public class ServiceClient : ClientBase<IService>, 
    IService

public ref class ServiceClient : public ClientBase<IService^>, 
    IService

type ServiceClient =  
    class
        inherit ClientBase<IService>
        interface IService
    end

public class ServiceClient extends ClientBase<IService> implements IService

The ServiceClient type exposes the following members.

Constructors

  Name Description
Public method ServiceClient() Initializes a new instance of the ServiceClient class with default values.
Public method ServiceClient(String) Initializes a new instance of the ServiceClient class with the specified endpoint configuration name.
Public method ServiceClient(Binding, EndpointAddress) Initializes a new instance of the ServiceClient class that has the specified binding and remote address.
Public method ServiceClient(String, EndpointAddress) Initializes a new instance of the ServiceClient class that has the specified endpoint configuration name and remote address.
Public method ServiceClient(String, String) Initializes a new instance of the ServiceClient class that has the specified endpoint configuration name and remote address as a string.

Top

Properties

  Name Description
Protected property Channel (Inherited from ClientBase<IService>.)
Public property ChannelFactory (Inherited from ClientBase<IService>.)
Public property ClientCredentials (Inherited from ClientBase<IService>.)
Public property Endpoint (Inherited from ClientBase<IService>.)
Public property InnerChannel (Inherited from ClientBase<IService>.)
Public property State (Inherited from ClientBase<IService>.)

Top

Methods

  Name Description
Public method Abort (Inherited from ClientBase<IService>.)
Public method AnnotationsDelete Deletes the existing annotation with the specified identifier.
Public method AnnotationsUpdate Updates the existing annotation with the specified identifier.
Public method AttributeChange Changes an attribute with the specified values.
Public method BusinessRulesClone Creates the new business rules using the specified set of business rules, retaining the globally unique identifiers (GUIDs) of the original objects.
Public method BusinessRulesCreate Creates new business rules instance.
Public method BusinessRulesDelete Deletes the business rule or components of rules with the given criteria.
Public method BusinessRulesGet Retrieves the business rules with the given criteria.
Public method BusinessRulesPaletteGet Retrieves the available business rule components (the component palette) for the specified member type.
Public method BusinessRulesPublish Publishes the business rules with the given criteria.
Public method BusinessRulesUpdate Updates the existing business rules.
Public method Close (Inherited from ClientBase<IService>.)
Protected method CreateChannel (Inherited from ClientBase<IService>.)
Public method DataQualityCleansingOperationCreate Infrastructure. Creates an operation for DQS quality cleansing.
Public method DataQualityInstalledState Infrastructure. Determines whether the DQS is properly installed and configured to work with Master Data Services with the specified setting.
Public method DataQualityKnowledgeBasesGet Infrastructure. Gets the collection of knowledgebase configured in DQS.
Public method DataQualityMatchingOperationCreate Infrastructure. Creates an operation for DQS matching.
Public method DataQualityOperationPurgeOperation Infrastructure. Returns a purge operation for DQS operation.
Public method DataQualityOperationResultsGet Infrastructure. Retrieves the results of a completed DQS operation.
Public method DataQualityOperationStart Infrastructure. Starts a DQS operation.
Public method DataQualityOperationStatus Infrastructure. Retrieves the status of a running DQS operation.
Public method DataQualityStoreInputData Infrastructure. Retrieves the data for the data quality store input.
Public method DisplayInitializationUI (Inherited from ClientBase<IService>.)
Public method EntityMemberAnnotationsCreate Creates new annotations attached to a member.
Public method EntityMemberAnnotationsGet Retrieves the annotations attached to a member.
Public method EntityMemberAttributesGet Retrieves a single attribute value for a member in an entity.
Public method EntityMemberKeyLookup This feature will be removed in the next version of Microsoft SQL Server. Do not use this feature in new development work, and modify applications that currently use this feature as soon as possible.
Public method EntityMembersCopy Copies the selected members to new target members.
Public method EntityMembersCreate Creates new members.
Public method EntityMembersDelete Deletes or deactivates the selected members.
Public method EntityMembersGet Retrieves the filtered set of members and their data from an entity.
Public method EntityMembersMerge Creates new members and updates existing members.
Public method EntityMembersUpdate Updates the existing members.
Public method EntityStagingClear Infrastructure. Clears the entity staging area with the specified batch identifier.
Public method EntityStagingGet Infrastructure. Retrieves the contents of the entity staging area.
Public method EntityStagingLoad Infrastructure. Loads the members and its relationship into the entity staging area.
Public method EntityStagingProcess Infrastructure. Sets the batch, via batch tag, entity identifier, member type, and version identifier, to be queued for processing.
Public method Equals (Inherited from Object.)
Public method ExportViewCreate Creates a new export (subscription) view.
Public method ExportViewDelete Removes the existing export view with the specified identifier.
Public method ExportViewListGet Retrieves the list of existing export views.
Public method ExportViewUpdate Updates the existing export view.
Protected method Finalize (Inherited from Object.)
Protected method GetDefaultValueForInitialization<T> (Inherited from ClientBase<IService>.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method HierarchyMembersGet Retrieves the parent-child members from a hierarchy relative to a parent node.
Protected method InvokeAsync (Inherited from ClientBase<IService>.)
Protected method MemberwiseClone (Inherited from Object.)
Public method MetadataClone Creates exact copies of metadata components from another source, retaining the globally unique identifiers (GUIDs) of the original objects.
Public method MetadataCreate Creates new metadata components.
Public method MetadataDelete Deletes the specified metadata components.
Public method MetadataGet Retrieves the metadata for the given criteria.
Public method MetadataUpdate Updates the specified metadata.
Public method ModelMembersBulkDelete Begins the asynchronous bulk deletion of members.
Public method ModelMembersBulkMerge Begins the asynchronous bulk creation and/or update of member data across one or more entities.
Public method ModelMembersBulkUpdate Begins the asynchronous bulk update of member data across one or more entities.
Public method ModelMembersGet Retrieves the entire selected models, entities and/or hierarchies.
Public method Open (Inherited from ClientBase<IService>.)
Public method SecurityPrincipalsClone Creates exact copies of users, groups and their permissions within the security model from another source, retaining the GUIDs of the original objects.
Public method SecurityPrincipalsCreate Creates new users, groups and their permissions within the security model.
Public method SecurityPrincipalsDelete Deletes users and groups.
Public method SecurityPrincipalsGet Retrieves security principals and their permissions.
Public method SecurityPrincipalsUpdate Updates security principals.
Public method SecurityPrivilegesClone Creates exact copies of permissions within the security model from another source, retaining the globally unique identifiers (GUIDs) of the original objects.
Public method SecurityPrivilegesCreate Creates security privileges.
Public method SecurityPrivilegesDelete Deletes the permissions for the specified criteria.
Public method SecurityPrivilegesGet Retrieves the security permissions for selected principals and/or models.
Public method SecurityPrivilegesUpdate Updates the specified security privileges.
Public method ServiceCheck Determines whether the Master Data Services Web service is up and running and is connected to the database.
Public method ServiceVersionGet Retrieves the version of the service instance.
Public method StagingClear Clears the bulk staging area.
Public method StagingGet Retrieves the contents of the bulk staging area.
Public method StagingNameCheck Checks the staging name to see if the name is unique or the name is already used.
Public method StagingProcess Sweeps the existing unbatched records in the staging tables into a batch for processing and launches execution of the staging queue on request.
Public method SystemDomainListGet Retrieves a localized fixed list of choices based on a list code.
Public method SystemPropertiesGet Retrieves the immutable properties about the system.
Public method SystemSettingsGet Retrieves the list of system settings.
Public method SystemSettingsUpdate Updates the system setting values.
Public method ToString (Inherited from Object.)
Public method TransactionAnnotationsCreate Creates new annotations attached to an existing transaction.
Public method TransactionAnnotationsGet Retrieves the filtered list of transaction annotations from a model.
Public method TransactionsGet Retrieves the filtered list of transactions from a model.
Public method TransactionsReverse Reverses one or more existing transactions.
Public method UserPreferencesDelete Deletes the specified user’s preferences.
Public method UserPreferencesGet Retrieves the specified user’s preferences.
Public method UserPreferencesUpdate Updates the specified user’s preferences.
Public method ValidationGet Gets the validation issues for the given search criteria.
Public method ValidationProcess Processes the validations (business rules) for selected members within a model.
Public method VersionCopy Makes a copy of a version, which includes making a copy of all entity member data.

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ICommunicationObject.BeginClose(AsyncCallback, Object) (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate method ICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object) (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate method ICommunicationObject.BeginOpen(AsyncCallback, Object) (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate method ICommunicationObject.BeginOpen(TimeSpan, AsyncCallback, Object) (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate method ICommunicationObject.Close (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate event ICommunicationObject.Closed (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate event ICommunicationObject.Closing (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate method IDisposable.Dispose (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate method ICommunicationObject.EndClose (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate method ICommunicationObject.EndOpen (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate event ICommunicationObject.Faulted (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate method IService.AnnotationsDelete Deletes an existing annotation.
Explicit interface implemetationPrivate method IService.AnnotationsUpdate Updates an existing annotation.
Explicit interface implemetationPrivate method IService.AttributeChange Changes an attribute.
Explicit interface implemetationPrivate method IService.BusinessRulesClone Creates new business rules which are exact copies of business rules from another source, retaining the globally unique identifiers (GUIDs) of the original objects.
Explicit interface implemetationPrivate method IService.BusinessRulesCreate Creates new business rules.
Explicit interface implemetationPrivate method IService.BusinessRulesDelete Deletes the business rule or components of rules.
Explicit interface implemetationPrivate method IService.BusinessRulesGet Retrieves the business rules.
Explicit interface implemetationPrivate method IService.BusinessRulesPaletteGet Retrieves the available business rule components (the component palette).
Explicit interface implemetationPrivate method IService.BusinessRulesPublish Publishes the business rules for a model or entity or member type.
Explicit interface implemetationPrivate method IService.BusinessRulesUpdate Updates the existing business rules.
Explicit interface implemetationPrivate method IService.DataQualityCleansingOperationCreate Infrastructure. Creates an operation request for DQS quality cleansing.
Explicit interface implemetationPrivate method IService.DataQualityInstalledState Infrastructure. Retrieves the DQS state – the response is positive if DQS is properly installed and configured to work with Master Data Services.
Explicit interface implemetationPrivate method IService.DataQualityKnowledgeBasesGet Infrastructure. Retrieves the list of knowledgebase configured in DQS.
Explicit interface implemetationPrivate method IService.DataQualityMatchingOperationCreate Infrastructure. Creates an operation request for DQS matching.
Explicit interface implemetationPrivate method IService.DataQualityOperationPurgeOperation Infrastructure. Returns a purge operation for DQS operation.
Explicit interface implemetationPrivate method IService.DataQualityOperationResultsGet Infrastructure. Retrieves the results of a completed DQS operation.
Explicit interface implemetationPrivate method IService.DataQualityOperationStart Infrastructure. Starts a DQS operation.
Explicit interface implemetationPrivate method IService.DataQualityOperationStatus Infrastructure. Retrieves the status of a running DQS operation.
Explicit interface implemetationPrivate method IService.DataQualityStoreInputData Infrastructure. Retrieves the data for the data quality store input.
Explicit interface implemetationPrivate method IService.EntityMemberAnnotationsCreate Creates new annotations attached to a member.
Explicit interface implemetationPrivate method IService.EntityMemberAnnotationsGet Retrieves the annotations attached to a member.
Explicit interface implemetationPrivate method IService.EntityMemberAttributesGet Retrieves the specified set of attribute values from a specified list of members.
Explicit interface implemetationPrivate method IService.EntityMemberKeyLookup This feature will be removed in the next version of Microsoft SQL Server. Do not use this feature in new development work, and modify applications that currently use this feature as soon as possible.
Explicit interface implemetationPrivate method IService.EntityMembersCopy Copies the selected members to new target members.
Explicit interface implemetationPrivate method IService.EntityMembersCreate Creates new members.
Explicit interface implemetationPrivate method IService.EntityMembersDelete Deletes or deactivates the selected members.
Explicit interface implemetationPrivate method IService.EntityMembersGet Retrieves the filtered set of members and their data from an entity.
Explicit interface implemetationPrivate method IService.EntityMembersMerge Creates new members and updates existing members.
Explicit interface implemetationPrivate method IService.EntityMembersUpdate Updates the existing members.
Explicit interface implemetationPrivate method IService.EntityStagingClear Infrastructure. Clears the entity staging area.
Explicit interface implemetationPrivate method IService.EntityStagingGet Infrastructure. Retrieves the contents of the entity staging area.
Explicit interface implemetationPrivate method IService.EntityStagingLoad Infrastructure. Loads the contents of the entity staging area.
Explicit interface implemetationPrivate method IService.EntityStagingProcess Infrastructure. Sets the batch to be queued for processing.
Explicit interface implemetationPrivate method IService.ExportViewCreate Generates or regenerates the desired subscription views.
Explicit interface implemetationPrivate method IService.ExportViewDelete Removes an existing export view.
Explicit interface implemetationPrivate method IService.ExportViewListGet Retrieves the list of existing export views.
Explicit interface implemetationPrivate method IService.ExportViewUpdate Updates an existing export view.
Explicit interface implemetationPrivate method IService.HierarchyMembersGet Retrieves the parent-child members from a hierarchy relative to a parent node.
Explicit interface implemetationPrivate method IService.MetadataClone Creates exact copies of metadata components from another source, retaining the globally unique identifiers (GUIDs) of the original objects.
Explicit interface implemetationPrivate method IService.MetadataCreate Creates new metadata components.
Explicit interface implemetationPrivate method IService.MetadataDelete Deletes the metadata components.
Explicit interface implemetationPrivate method IService.MetadataGet Retrieves a metadata.
Explicit interface implemetationPrivate method IService.MetadataUpdate Updates a metadata.
Explicit interface implemetationPrivate method IService.ModelMembersBulkDelete Begins the asynchronous bulk deletion of members.
Explicit interface implemetationPrivate method IService.ModelMembersBulkMerge Begins the asynchronous bulk creation and/or update of member data across one or more entities.
Explicit interface implemetationPrivate method IService.ModelMembersBulkUpdate Begins the asynchronous bulk update of member data across one or more entities.
Explicit interface implemetationPrivate method IService.ModelMembersGet Retrieves the entire selected models, entities and/or hierarchies.
Explicit interface implemetationPrivate method IService.SecurityPrincipalsClone Creates exact copies of users, groups and their permissions within the security model from another source, retaining the GUIDs of the original objects.
Explicit interface implemetationPrivate method IService.SecurityPrincipalsCreate Creates new users, groups and their permissions within the security model.
Explicit interface implemetationPrivate method IService.SecurityPrincipalsDelete Deletes user and groups.
Explicit interface implemetationPrivate method IService.SecurityPrincipalsGet Retrieves the security principals and their permissions.
Explicit interface implemetationPrivate method IService.SecurityPrincipalsUpdate Updates the security principals.
Explicit interface implemetationPrivate method IService.SecurityPrivilegesClone Creates an exact copy of permissions within the security model from another source, retaining the globally unique identifiers (GUIDs) of the original objects.
Explicit interface implemetationPrivate method IService.SecurityPrivilegesCreate Creates the security privileges.
Explicit interface implemetationPrivate method IService.SecurityPrivilegesDelete Deletes the permissions.
Explicit interface implemetationPrivate method IService.SecurityPrivilegesGet Retrieves the security permissions for selected principals and/or models.
Explicit interface implemetationPrivate method IService.SecurityPrivilegesUpdate Updates the security privileges.
Explicit interface implemetationPrivate method IService.ServiceCheck Determines whether the Master Data Services Web service is up and running and is connected to the database.
Explicit interface implemetationPrivate method IService.ServiceVersionGet Retrieves the service version.
Explicit interface implemetationPrivate method IService.StagingClear Clears the bulk staging area.
Explicit interface implemetationPrivate method IService.StagingGet Retrieves the contents of the bulk staging area.
Explicit interface implemetationPrivate method IService.StagingNameCheck Checks the staging name to see if the name is unique or the name is already used.
Explicit interface implemetationPrivate method IService.StagingProcess Sweeps the existing unbatched records in the staging tables into a batch for processing and launches execution of the staging queue on request.
Explicit interface implemetationPrivate method IService.SystemDomainListGet Retrieves the localized fixed list of choices based on a list code.
Explicit interface implemetationPrivate method IService.SystemPropertiesGet Retrieves the immutable properties about the system.
Explicit interface implemetationPrivate method IService.SystemSettingsGet Retrieves the list of system settings.
Explicit interface implemetationPrivate method IService.SystemSettingsUpdate Updates the system setting values.
Explicit interface implemetationPrivate method IService.TransactionAnnotationsCreate Creates new annotations attached to an existing transaction.
Explicit interface implemetationPrivate method IService.TransactionAnnotationsGet Retrieves the filtered list of transaction annotations from a model.
Explicit interface implemetationPrivate method IService.TransactionsGet Retrieves the filtered list of transactions from a model.
Explicit interface implemetationPrivate method IService.TransactionsReverse Reverses one or more existing transactions.
Explicit interface implemetationPrivate method IService.UserPreferencesDelete Deletes the current user’s preferences.
Explicit interface implemetationPrivate method IService.UserPreferencesGet Retrieves the current user’s preferences.
Explicit interface implemetationPrivate method IService.UserPreferencesUpdate Updates the current user’s preferences.
Explicit interface implemetationPrivate method IService.ValidationGet Gets the validation issues for the given criteria.
Explicit interface implemetationPrivate method IService.ValidationProcess Processes the validations (business rules) for selected members within a model.
Explicit interface implemetationPrivate method IService.VersionCopy Copies a model version to a new version.
Explicit interface implemetationPrivate method ICommunicationObject.Open (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate event ICommunicationObject.Opened (Inherited from ClientBase<IService>.)
Explicit interface implemetationPrivate event ICommunicationObject.Opening (Inherited from ClientBase<IService>.)

Top

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.MasterDataServices Namespace