Interface ITopicMetricCollectorBuilder
A topic metric collector builder.
Inherited Members
Namespace: PushTechnology.ClientInterface.Client.Features.Metrics
Assembly: Diffusion.Client.dll
Syntax
public interface ITopicMetricCollectorBuilder : IMetricCollectorBuilderRemarks
A builder of this type may be created using NewTopicMetricCollectorBuilder() and used to create instances of ITopicMetricCollector that can be supplied to PutTopicMetricCollectorAsync(ITopicMetricCollector).
Methods
Create(String, String)
Creates a new ITopicMetricCollector using the values currently known to this builder.
Declaration
ITopicMetricCollector Create(string name, string topicSelector)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The name of the ITopicMetricCollector. |
| System.String | topicSelector | The selector pattern that specifies the topics for which metrics are to be collected. |
Returns
| Type | Description |
|---|---|
| ITopicMetricCollector | A new ITopicMetricCollector with all of the current settings of this builder. |
Exceptions
| Type | Condition |
|---|---|
| TopicSelectorFormatException | The |
GroupByPathPrefixParts(Int32)
Specifies the number of leading parts of the topic path the metric collector should use to group results. Since 6.8.
Declaration
ITopicMetricCollectorBuilder GroupByPathPrefixParts(int parts)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | parts | The number of leading parts of the topic path to group by. Set to 0 to disable grouping by path. |
Returns
| Type | Description |
|---|---|
| ITopicMetricCollectorBuilder | This builder. |
Remarks
By default a topic metric collector does not group by the topic path prefix. If a positive number of parts is specified, it will enable grouping.
GroupByTopicType(Boolean)
Specifies whether the metric collector should group by topic type.
Declaration
ITopicMetricCollectorBuilder GroupByTopicType(bool groupByTopicType)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | groupByTopicType | True to indicate that the collector should group by topic type. |
Returns
| Type | Description |
|---|---|
| ITopicMetricCollectorBuilder | This builder. |
Remarks
By default a topic metric collector does not group by topic type.
GroupByTopicView(Boolean)
Specifies whether the metric collector should group by topic view. Since 6.9.
Declaration
ITopicMetricCollectorBuilder GroupByTopicView(bool groupByTopicView)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | groupByTopicView | True to indicate that the collector should group by topic view. |
Returns
| Type | Description |
|---|---|
| ITopicMetricCollectorBuilder | This builder. |
Remarks
By default a topic metric collector does not group by topic view.