IMetadataSerializationHost Interface

Definition

Namespace:

Microsoft.AnalysisServices.Tabular.Serialization

Assembly:

Microsoft.AnalysisServices.Tabular.dll

Package:

Microsoft.AnalysisServices v19.86.2.1

Represents a host for a metadata serialization actions.

public interface IMetadataSerializationHost

type IMetadataSerializationHost = interface

Public Interface IMetadataSerializationHost

Remarks

Inplementing this interface enables the host to get notifications about the progress of serializzation related activity.

The sequence of notifications during a serialization operation:

• The OperationStartNotification(Boolean, Object, IReadOnlyCollection<String>) will be invoked in the beginning of the operation, providing the set of documents that are being serialized or deserialized.
• The DocumentStartNotification(Boolean, Object, String) will be invoked for every document that is being serialized or deserialized, prior for the actual activity.
• If an error happen during the serialization activity, the ErrorNotification(Boolean, Object, Exception) will be invoked providing the error.
• The DocumentEndNotification(Boolean, Object, String, Boolean) will be invoked for every document that is being serialized or deserialized, after the completion of the activity, with an indication if the activity was successful or not.
• The OperationEndNotification(Boolean, Object, Boolean) will be invoked in the completion of the entire operation, with an indication if the overall operation was successful or not.

Methods

DocumentEndNotification(Boolean, Object, String, Boolean)	A notification of the completion of a serialization operation of a particular document.
DocumentStartNotification(Boolean, Object, String)	A notification of the start of a serialization operation of a particular document.
ErrorNotification(Boolean, Object, Exception)	A notification of an error during a serialization operation.
OperationEndNotification(Boolean, Object, Boolean)	A notification of the completion of a serialization operation.
OperationStartNotification(Boolean, Object, IReadOnlyCollection<String>)	A notification of the start of a serialization operation.