Interface ITopicResult

Namespace

PushTechnology.ClientInterface.Client.Features

Assembly

Diffusion.Client.dll

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

public interface ITopicResult

Properties

Path

Gets the topic path.

string Path { get; }

Property Value

string

The topic path.

Specification

Gets the topic specification.

ITopicSpecification Specification { get; }

Property Value

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.

TopicType Type { get; }

Property Value

TopicType

The topic type.

ValueCount

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

int ValueCount { get; }

Property Value

int

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.

int ValueSize { get; }

Property Value

int

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.

long ValueTotalSize { get; }

Property Value

long

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).