HeartRateRecord
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.SampleRepresents a single measurement of the heart rate. |
Public fields |
|
|---|---|
static final @NonNull AggregateMetric<@NonNull Long> |
Metric identifier to retrieve the average heart rate from |
static final @NonNull AggregateMetric<@NonNull Long> |
Metric identifier to retrieve the maximum heart rate from |
static final @NonNull AggregateMetric<@NonNull Long> |
Metric identifier to retrieve the minimum heart rate from |
static final @NonNull AggregateMetric<@NonNull Long> |
Metric identifier to retrieve the number of heart rate measurements from |
Public constructors |
|---|
HeartRateRecord( |
Public methods |
|
|---|---|
boolean |
|
@NonNull Instant |
End time of the record. |
ZoneOffset |
User experienced zone offset at |
@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 |
int |
hashCode() |
@NonNull String |
toString() |
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
public HeartRateRecord(
@NonNull Instant startTime,
ZoneOffset startZoneOffset,
@NonNull Instant endTime,
ZoneOffset endZoneOffset,
@NonNull List<@NonNull HeartRateRecord.Sample> samples,
@NonNull Metadata metadata
)
Public methods
getEndZoneOffset
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
public @NonNull Metadata getMetadata()
Set of common metadata associated with the written record.
getStartZoneOffset
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.