Interface ISessionMetricCollectorBuilder
A session metric collector builder.
Inherited Members
Namespace: PushTechnology.ClientInterface.Client.Features.Metrics
Assembly: Diffusion.Client.dll
Syntax
public interface ISessionMetricCollectorBuilder : IMetricCollectorBuilder
Methods
Create(String, String)
Create a new ISessionMetricCollector using the values currently known to this builder.
Declaration
ISessionMetricCollector Create(string name, string sessionFilter)
Parameters
Type | Name | Description |
---|---|---|
String | name | The name of the ISessionMetricCollector. |
String | sessionFilter | The session filter indicating the sessions this collector should apply to. The format of a session property filter is documented in ISession. |
Returns
Type | Description |
---|---|
ISessionMetricCollector | A new ISessionMetricCollector with all of the current settings of this builder. |
GroupByProperties(List<String>)
Specifies a list of session property names to group by, replacing any current list known to this builder.
Declaration
ISessionMetricCollectorBuilder GroupByProperties(List<string> propertyNames)
Parameters
Type | Name | Description |
---|---|---|
List<String> | propertyNames | A list of session property names. See ISession for details of session properties. |
Returns
Type | Description |
---|---|
ISessionMetricCollectorBuilder | This builder. |
GroupByProperty(String)
Adds the name of a session property to group by to the list known to this builder.
Declaration
ISessionMetricCollectorBuilder GroupByProperty(string propertyName)
Parameters
Type | Name | Description |
---|---|---|
String | propertyName | The name of the session property. See ISession for details of session properties. |
Returns
Type | Description |
---|---|
ISessionMetricCollectorBuilder | This builder. |
RemoveMetricsWithNoMatches(Boolean)
Specifies whether the metric collector should remove any metrics that have no matches.
Declaration
ISessionMetricCollectorBuilder RemoveMetricsWithNoMatches(bool remove)
Parameters
Type | Name | Description |
---|---|---|
Boolean | remove | True to indicate that metrics with no matches should be removed |
Returns
Type | Description |
---|---|
ISessionMetricCollectorBuilder | This builder. |