com.tibco.cep.runtime.appmetrics

## Interface MetricsRecordBuilder

-     public interface MetricsRecordBuilder

  The BusinessEvents inference engine uses MetricsRecordBuilder to create and build MetricRecord for each entity in a RTC change list that is configured to publish to a target metric store.
  Since:
    6.1.0

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `MetricsRecordBuilder` | `addField(java.lang.String fieldName, java.lang.Boolean fieldValue)` Add a Boolean field to metric record.
    `MetricsRecordBuilder` | `addField(java.lang.String fieldName, java.util.Calendar fieldValue)` Add a Calendar field to metric record.
    `MetricsRecordBuilder` | `addField(java.lang.String fieldName, java.lang.Double fieldValue)` Add a Double field to metric record.
    `MetricsRecordBuilder` | `addField(java.lang.String fieldName, java.lang.Integer fieldValue)` Add a Integer field to metric record.
    `MetricsRecordBuilder` | `addField(java.lang.String fieldName, java.lang.Long fieldValue)` Add a Long field to metric record.
    `MetricsRecordBuilder` | `addField(java.lang.String fieldName, java.lang.String fieldValue)` Add a String field to metric record.
    `MetricsRecordBuilder` | `addId(Id id)` Add {@link Id) to metric record.
    `MetricsRecordBuilder` | `addTags(java.util.Collection tags)` Add a common tags to metric record.
    `MetricsRecordBuilder` | `addVersion(int version)` Add version to metric record.
    `java.lang.Object` | `build()` Build and return store specific metric

- - ### Method Detail

    - #### addId

          MetricsRecordBuilder addId(Id id)

      Add {@link Id) to metric record.
      Parameters:
        `id` - - unique identifiers for an entity
      Returns:
        builder
      Since:
        6.1.0
      See Also:
        `Id`

    - #### addVersion

          MetricsRecordBuilder addVersion(int version)

      Add version to metric record.
      Parameters:
        `version` - - the latest version of the entity
      Returns:
        builder
      Since:
        6.1.0

    - #### addField

          MetricsRecordBuilder addField(java.lang.String fieldName,
                                        java.lang.String fieldValue)

      Add a String field to metric record.
      Parameters:
        `fieldName` -
        `fieldValue` -
      Returns:
        builder
      Since:
        6.1.0

    - #### addField

          MetricsRecordBuilder addField(java.lang.String fieldName,
                                        java.lang.Integer fieldValue)

      Add a Integer field to metric record.
      Parameters:
        `fieldName` -
        `fieldValue` -
      Returns:
        builder
      Since:
        6.1.0

    - #### addField

          MetricsRecordBuilder addField(java.lang.String fieldName,
                                        java.lang.Long fieldValue)

      Add a Long field to metric record.
      Parameters:
        `fieldName` -
        `fieldValue` -
      Returns:
        builder
      Since:
        6.1.0

    - #### addField

          MetricsRecordBuilder addField(java.lang.String fieldName,
                                        java.lang.Boolean fieldValue)

      Add a Boolean field to metric record.
      Parameters:
        `fieldName` -
        `fieldValue` -
      Returns:
        builder
      Since:
        6.1.0

    - #### addField

          MetricsRecordBuilder addField(java.lang.String fieldName,
                                        java.lang.Double fieldValue)

      Add a Double field to metric record.
      Parameters:
        `fieldName` -
        `fieldValue` -
      Returns:
        builder
      Since:
        6.1.0

    - #### addField

          MetricsRecordBuilder addField(java.lang.String fieldName,
                                        java.util.Calendar fieldValue)

      Add a Calendar field to metric record.
      Parameters:
        `fieldName` -
        `fieldValue` -
      Returns:
        builder
      Since:
        6.1.0

    - #### addTags

          MetricsRecordBuilder addTags(java.util.Collection tags)

      Add a common tags to metric record.
      Parameters:
        `iterator` - - name
      Returns:
        builder
      Since:
        6.1.0

    - #### build

          java.lang.Object build()

      Build and return store specific metric
      Returns:
        T store specific metric
      Since:
        6.1.0