Package com.pushtechnology.diffusion.client.features.control

Interface Metrics.SessionMetricCollector.Builder

All Superinterfaces:
Metrics.Builder<Metrics.SessionMetricCollector.Builder>
Enclosing interface:
Metrics.SessionMetricCollector
public static interface Metrics.SessionMetricCollector.Builder extends Metrics.Builder<Metrics.SessionMetricCollector.Builder>
A session metric collector builder.

A builder of this type may be created using newSessionMetricCollectorBuilder and used to create instances of Metrics.SessionMetricCollector that can be supplied to putSessionMetricCollector.

  • Method Details

    • groupByProperty

      Metrics.SessionMetricCollector.Builder groupByProperty(String propertyName)
      Adds the name of a session property to group by to the list known to this builder.

      By default a builder will initially have no session properties to group by set.

      Parameters:
      propertyName - the name of the session property. See Session for details of session properties
      Returns:
      this builder

    • groupByProperties

      Metrics.SessionMetricCollector.Builder groupByProperties(List<String> propertyNames)
      Specifies a list of session property names to group by, replacing any current list known to this builder.
      Parameters:
      propertyNames - a list of session property names. See Session for details of session properties
      Returns:
      this builder

    • removeMetricsWithNoMatches

      Metrics.SessionMetricCollector.Builder removeMetricsWithNoMatches(boolean remove)
      Specifies whether the metric collector should remove any metrics that have no matches.

      The default is that the metric collector will not remove metrics with no matches.

      Parameters:
      remove - true to indicate that metrics with no matches should be removed
      Returns:
      this builder

    • create

      Metrics.SessionMetricCollector create(String name, String sessionFilter)
      Create a new Metrics.SessionMetricCollector using the values currently known to this builder.
      Parameters:
      name - the name of the Metrics.SessionMetricCollector
      sessionFilter - the session filter indicating the sessions this collector should apply to. The format of a session property filter is documented in Session
      Returns:
      a new Metrics.SessionMetricCollector with all of the current settings of this builder