Interface ITopicResult

The result of a FetchAsync(String) invocation for a single selected topic.

Namespace: PushTechnology.ClientInterface.Client.Features

Assembly: Diffusion.Client.dll

Syntax

public interface ITopicResult

Properties

Path

Gets the topic path.

Declaration

string Path { get; }

Property Value

Type	Description
System.String	The topic path.

Specification

Gets the topic specification.

Declaration

ITopicSpecification Specification { get; }

Property Value

Type	Description
ITopicSpecification	The topic specification.

Remarks

If the request specified WithProperties(), the result reflects the topic's specification and can be used to create an identical topic. If the request did not specify WithProperties(), the specification's property map will be empty.

Type

Gets the topic type.

Declaration

TopicType Type { get; }

Property Value

Type	Description
TopicType	The topic type.

ValueCount

Returns the number of values that the topic has. For a topic with no value this will return 0.

Declaration

int ValueCount { get; }

Property Value

Type	Description
System.Int32	The value count.

Remarks

For a non-times series topic with a value this will return 1. For a time series topic this will return the number of events.

ValueSize

Returns the size of the topic’s value (in bytes) or 0 if the topic has no value.

Declaration

int ValueSize { get; }

Property Value

Type	Description
System.Int32	The value size.

Remarks

For time series topics this will be the size of the last event.

ValueTotalSize

Returns the total value size of a topic.

Declaration

long ValueTotalSize { get; }

Property Value

Type	Description
System.Int64	The total value size of a topic.

Remarks

For a non-time series topic this will be the same as ValueSize. For a time series topic this will be the total size of all events (in bytes).