openPDC Historian Help
RestWebServiceMetadataProvider Class
NamespacesTVA.Historian.MetadataProvidersRestWebServiceMetadataProvider
Represents a provider of data to a MetadataFile from a REST (Representational State Transfer) web service.
Declaration Syntax
C#Visual BasicVisual C++
public class RestWebServiceMetadataProvider : MetadataProviderBase
Public Class RestWebServiceMetadataProvider _
	Inherits MetadataProviderBase
public ref class RestWebServiceMetadataProvider : public MetadataProviderBase
Members
All MembersConstructorsMethodsPropertiesEvents



IconMemberDescription
RestWebServiceMetadataProvider()()()
Initializes a new instance of the RestWebServiceMetadataProvider class.

Dispose()()()
Releases all the resources used by the metadata provider.
(Inherited from MetadataProviderBase.)
Dispose(Boolean)
Releases the unmanaged resources used by the metadata provider and optionally releases the managed resources.
(Inherited from MetadataProviderBase.)
Enabled
Gets or sets a boolean value that indicates whether the metadata provider is currently enabled.
(Inherited from MetadataProviderBase.)
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()()
Releases the unmanaged resources before the metadata provider is reclaimed by GC.
(Inherited from MetadataProviderBase.)
GetHashCode()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
Initialize()()()
Initializes the metadata provider.
(Inherited from MetadataProviderBase.)
LoadSettings()()()
Loads saved RestWebServiceMetadataProvider settings from the config file if the PersistSettings property is set to true.
(Overrides MetadataProviderBase.LoadSettings()()().)
MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Metadata
Gets or sets the MetadataFile to be refreshed by the metadata provider.
(Inherited from MetadataProviderBase.)
MetadataRefreshComplete
Occurs when Refresh()()() of Metadata is completed.
(Inherited from MetadataProviderBase.)
MetadataRefreshException
Occurs when an Exception is encountered during Refresh()()() of Metadata.
(Inherited from MetadataProviderBase.)
MetadataRefreshStart
Occurs when Refresh()()() of Metadata is started.
(Inherited from MetadataProviderBase.)
MetadataRefreshTimeout
Occurs when Refresh()()() of Metadata times out.
(Inherited from MetadataProviderBase.)
OnMetadataRefreshComplete()()()
Raises the MetadataRefreshComplete event.
(Inherited from MetadataProviderBase.)
OnMetadataRefreshException(Exception)
Raises the MetadataRefreshException event.
(Inherited from MetadataProviderBase.)
OnMetadataRefreshStart()()()
Raises the MetadataRefreshStart event.
(Inherited from MetadataProviderBase.)
OnMetadataRefreshTimeout()()()
Raises the MetadataRefreshTimeout event.
(Inherited from MetadataProviderBase.)
PersistSettings
Gets or sets a boolean value that indicates whether the metadata provider settings are to be saved to the config file.
(Inherited from MetadataProviderBase.)
Refresh()()()
Refreshes the Metadata from an external source.
(Inherited from MetadataProviderBase.)
RefreshInterval
Gets or sets the interval in minutes at which the Metadata if to be refreshed automatically.
(Inherited from MetadataProviderBase.)
RefreshMetadata()()()
Refreshes the Metadata from a REST web service.
(Overrides MetadataProviderBase.RefreshMetadata()()().)
RefreshTimeout
Gets or sets the number of seconds to wait for the Refresh()()() to complete.
(Inherited from MetadataProviderBase.)
SaveSettings()()()
Saves RestWebServiceMetadataProvider settings to the config file if the PersistSettings property is set to true.
(Overrides MetadataProviderBase.SaveSettings()()().)
ServiceDataFormat
Gets or sets the SerializationFormat in which the REST web service exposes the data.

ServiceUri
Gets or sets the URI where the REST web service is hosted.

SettingsCategory
Gets or sets the category under which the metadata provider settings are to be saved to the config file if the PersistSettings property is set to true.
(Inherited from MetadataProviderBase.)
ToString()()()
Returns a String that represents the current Object.
(Inherited from Object.)
Inheritance Hierarchy
Object
MetadataProviderBase
 RestWebServiceMetadataProvider
See Also

Assembly: TVA.Historian (Module: TVA.Historian) Version: 1.0.33.39252