Class PsiStreamMetadata
Represents metadata used in storing stream data in a Psi store.
Implements
Inherited Members
Namespace: Microsoft.Psi
Assembly: Microsoft.Psi.dll
Syntax
public sealed class PsiStreamMetadata : Metadata, IStreamMetadata
Properties
View SourceAverageMessageLatencyMs
Gets the average latency (milliseconds) of messages in the stream.
Declaration
public double AverageMessageLatencyMs { get; }
Property Value
Type | Description |
---|---|
System.Double |
AverageMessageSize
Gets the average size (bytes) of messages in the stream.
Declaration
public double AverageMessageSize { get; }
Property Value
Type | Description |
---|---|
System.Double |
ClosedTime
Gets the time when the stream was closed.
Declaration
public DateTime ClosedTime { get; }
Property Value
Type | Description |
---|---|
DateTime |
CustomFlags
Gets the custom flags implemented in derived types.
Declaration
public ushort CustomFlags { get; }
Property Value
Type | Description |
---|---|
System.UInt16 |
FirstMessageCreationTime
Gets the first creation time of a message in the stream.
Declaration
public DateTime FirstMessageCreationTime { get; }
Property Value
Type | Description |
---|---|
DateTime |
See Also
View SourceFirstMessageOriginatingTime
Gets the first originating time of a message in the stream.
Declaration
public DateTime FirstMessageOriginatingTime { get; }
Property Value
Type | Description |
---|---|
DateTime |
See Also
View SourceIsClosed
Gets a value indicating whether the stream has been closed.
Declaration
public bool IsClosed { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsIndexed
Gets a value indicating whether the stream is indexed.
Declaration
public bool IsIndexed { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsPersisted
Gets a value indicating whether the stream is persisted.
Declaration
public bool IsPersisted { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsPolymorphic
Gets a value indicating whether the stream is persisted.
Declaration
public bool IsPolymorphic { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
LastMessageCreationTime
Gets the last creation time of a message in the stream.
Declaration
public DateTime LastMessageCreationTime { get; }
Property Value
Type | Description |
---|---|
DateTime |
See Also
View SourceLastMessageOriginatingTime
Gets the last originating time of a message in the stream.
Declaration
public DateTime LastMessageOriginatingTime { get; }
Property Value
Type | Description |
---|---|
DateTime |
See Also
View SourceLatencyCumulativeSum
Gets the cumulative sum of latencies of messages in the stream.
Declaration
public long LatencyCumulativeSum { get; }
Property Value
Type | Description |
---|---|
System.Int64 |
MessageCount
Gets the number of messages in the stream.
Declaration
public long MessageCount { get; }
Property Value
Type | Description |
---|---|
System.Int64 |
MessageCreationTimeInterval
Gets the interval between the creation times of the first and last messages written to this stream. If the stream contains no messages, an empty interval is returned.
Declaration
public TimeInterval MessageCreationTimeInterval { get; }
Property Value
Type | Description |
---|---|
TimeInterval |
MessageOriginatingTimeInterval
Gets the interval between the originating times of the first and last messages written to this stream. If the stream contains no messages, an empty interval is returned.
Declaration
public TimeInterval MessageOriginatingTimeInterval { get; }
Property Value
Type | Description |
---|---|
TimeInterval |
MessageSizeCumulativeSum
Gets the total size (bytes) of messages in the stream.
Declaration
public long MessageSizeCumulativeSum { get; }
Property Value
Type | Description |
---|---|
System.Int64 |
OpenedTime
Gets the time when the stream was opened.
Declaration
public DateTime OpenedTime { get; }
Property Value
Type | Description |
---|---|
DateTime |
RuntimeTypes
Gets a dictionary of runtime type names referenced in stream.
Declaration
public Dictionary<int, string> RuntimeTypes { get; }
Property Value
Type | Description |
---|---|
Dictionary<System.Int32, String> |
StoreName
Gets the name of the store containing the stream.
Declaration
public string StoreName { get; }
Property Value
Type | Description |
---|---|
String |
StorePath
Gets the path of the store containing the stream.
Declaration
public string StorePath { get; }
Property Value
Type | Description |
---|---|
String |
StreamTimeInterval
Gets the time interval this stream was in existence (from open to close).
Declaration
public TimeInterval StreamTimeInterval { get; }
Property Value
Type | Description |
---|---|
TimeInterval |
SupplementalMetadataTypeName
Gets the name of the type of supplemental metadata for the stream the metadata represents.
Declaration
public string SupplementalMetadataTypeName { get; }
Property Value
Type | Description |
---|---|
String |
TypeName
Gets the name of the type of data contained in the stream.
Declaration
public string TypeName { get; }
Property Value
Type | Description |
---|---|
String |
Methods
View SourceGetSupplementalMetadata<T>()
Gets supplemental stream metadata.
Declaration
public T GetSupplementalMetadata<T>()
Returns
Type | Description |
---|---|
T | Supplemental metadata. |
Type Parameters
Name | Description |
---|---|
T | Type of supplemental metadata. |
GetSupplementalMetadata<T>(KnownSerializers)
Gets supplemental stream metadata.
Declaration
public T GetSupplementalMetadata<T>(KnownSerializers serializers)
Parameters
Type | Name | Description |
---|---|---|
KnownSerializers | serializers | Known serializers. |
Returns
Type | Description |
---|---|
T | Supplemental metadata. |
Type Parameters
Name | Description |
---|---|
T | Type of supplemental metadata. |
Update(Envelope, Int32)
Updates this stream metadata with the specified envelope and size.
Declaration
public void Update(Envelope envelope, int size)
Parameters
Type | Name | Description |
---|---|---|
Envelope | envelope | The envelope. |
System.Int32 | size | The size. |
Update(TimeInterval, TimeInterval)
Updates this stream metadata with the times and originating times of the first and last messages.
Declaration
public void Update(TimeInterval messagesTimeInterval, TimeInterval messagesOriginatingTimeInterval)
Parameters
Type | Name | Description |
---|---|---|
TimeInterval | messagesTimeInterval | A TimeInterval representing the times of the first and last messages in the stream. |
TimeInterval | messagesOriginatingTimeInterval | A TimeInterval representing the originating times of the first and last messages in the stream. |