ObjectMetricType

public class ObjectMetricType<K> where K : ObjectSerialize

This implements the developer facing API for the object metric type.

Instances of this class type are automatically generated by the parsers at built time, allowing developers to record events that were previously registered in the metrics.yaml file.

The Events API only exposes the ObjectMetricType.set(obj:) method, which takes care of validating the input data and making sure that limits are enforced.

  • The public constructor used by automatically generated metrics.

    Declaration

    Swift

    public init(_ meta: CommonMetricData)

  • Sets to the associated structure.

    Declaration

    Swift

    public func set(_ object: K)

    Parameters

    object

    the object to set.

  • Returns the stored value for testing purposes only. This function will attempt to await the last task (if any) writing to the the metric’s storage engine before returning a value.

    Declaration

    Swift

    public func testGetValue(_ pingName: String? = nil) -> K?

    Parameters

    pingName

    represents the name of the ping to retrieve the metric for. Defaults to the first value in sendInPings.

    Return Value

    value of the stored metric decoded into the associated object or nil if nothing was recorded.

  • Returns the number of errors recorded for the given metric.

    Declaration

    Swift

    public func testGetNumRecordedErrors(_ errorType: ErrorType) -> Int32

    Parameters

    errorType

    The type of error recorded.

    Return Value

    The number of errors recorded for the metric for the given error type.