public final class HeartRateRecord implements Record

Captures the user's heart rate. Each record represents a series of measurements.

Summary

Nested types
public final class HeartRateRecord.Sample

Represents a single measurement of the heart rate.

Public fields
static final @NonNull AggregateMetric<@NonNull Long>

Metric identifier to retrieve the average heart rate from AggregationResult.
static final @NonNull AggregateMetric<@NonNull Long>

Metric identifier to retrieve the maximum heart rate from AggregationResult.
static final @NonNull AggregateMetric<@NonNull Long>

Metric identifier to retrieve the minimum heart rate from AggregationResult.
static final @NonNull AggregateMetric<@NonNull Long>

Metric identifier to retrieve the number of heart rate measurements from AggregationResult.

Public constructors
HeartRateRecord(
    @NonNull Instant startTime,
    ZoneOffset startZoneOffset,
    @NonNull Instant endTime,
    ZoneOffset endZoneOffset,
    @NonNull List<@NonNull HeartRateRecord.Sample> samples,
    @NonNull Metadata metadata
)

Public methods
boolean
equals(Object other)
@NonNull Instant

End time of the record.
ZoneOffset

User experienced zone offset at endTime, or null if unknown.
@NonNull Metadata

Set of common metadata associated with the written record.
@NonNull List<@NonNull HeartRateRecord.Sample>
@NonNull Instant

Start time of the record.
ZoneOffset

User experienced zone offset at startTime, or null if unknown.
int
@NonNull String

Public fields

BPM_AVG

public static final @NonNull AggregateMetric<@NonNull Long> BPM_AVG

Metric identifier to retrieve the average heart rate from AggregationResult.

BPM_MAX

public static final @NonNull AggregateMetric<@NonNull Long> BPM_MAX

Metric identifier to retrieve the maximum heart rate from AggregationResult.

BPM_MIN

public static final @NonNull AggregateMetric<@NonNull Long> BPM_MIN

Metric identifier to retrieve the minimum heart rate from AggregationResult.

MEASUREMENTS_COUNT

public static final @NonNull AggregateMetric<@NonNull Long> MEASUREMENTS_COUNT

Metric identifier to retrieve the number of heart rate measurements from AggregationResult.

Public constructors

HeartRateRecord

Added in 1.1.0-alpha10
public HeartRateRecord(
    @NonNull Instant startTime,
    ZoneOffset startZoneOffset,
    @NonNull Instant endTime,
    ZoneOffset endZoneOffset,
    @NonNull List<@NonNull HeartRateRecord.Sample> samples,
    @NonNull Metadata metadata
)

Public methods

equals

public boolean equals(Object other)

getEndTime

Added in 1.1.0-alpha10
public @NonNull Instant getEndTime()

End time of the record.

getEndZoneOffset

Added in 1.1.0-alpha10
public ZoneOffset getEndZoneOffset()

User experienced zone offset at endTime, or null if unknown. Providing these will help history aggregations results stay consistent should user travel. Queries with user experienced time filters will assume system current zone offset if the information is absent.

getMetadata

Added in 1.1.0-alpha10
public @NonNull Metadata getMetadata()

Set of common metadata associated with the written record.

getSamples

Added in 1.1.0-alpha10
public @NonNull List<@NonNull HeartRateRecord.Sample> getSamples()

getStartTime

Added in 1.1.0-alpha10
public @NonNull Instant getStartTime()

Start time of the record.

getStartZoneOffset

Added in 1.1.0-alpha10
public ZoneOffset getStartZoneOffset()

User experienced zone offset at startTime, or null if unknown. Providing these will help history aggregations results stay consistent should user travel. Queries with user experienced time filters will assume system current zone offset if the information is absent.

hashCode

public int hashCode()

toString

public @NonNull String toString()