Interface Sleep.SleepSummaryOrBuilder (0.2.0)

public static interface Sleep.SleepSummaryOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getMinutesAfterWakeUp()

public abstract long getMinutesAfterWakeUp()

Output only. Minutes after wake up calculated by restlessness algorithm.

optional int64 minutes_after_wake_up = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The minutesAfterWakeUp.

getMinutesAsleep()

public abstract long getMinutesAsleep()

Output only. Total number of minutes asleep. For classic sleep it is the sum of ASLEEP stages (excluding AWAKE and RESTLESS). For "stages" sleep it is the sum of LIGHT, REM and DEEP stages (excluding AWAKE).

optional int64 minutes_asleep = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The minutesAsleep.

getMinutesAwake()

public abstract long getMinutesAwake()

Output only. Total number of minutes awake. It is a sum of all AWAKE stages.

optional int64 minutes_awake = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The minutesAwake.

getMinutesInSleepPeriod()

public abstract long getMinutesInSleepPeriod()

Output only. Delta between wake time and bedtime. It is the sum of all stages.

optional int64 minutes_in_sleep_period = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The minutesInSleepPeriod.

getMinutesToFallAsleep()

public abstract long getMinutesToFallAsleep()

Output only. Minutes to fall asleep calculated by restlessness algorithm.

optional int64 minutes_to_fall_asleep = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The minutesToFallAsleep.

getStagesSummary(int index)

public abstract Sleep.SleepSummary.StageSummary getStagesSummary(int index)

Output only. List of summaries (total duration and segment count) per each sleep stage type.

repeated .google.devicesandservices.health.v4.Sleep.SleepSummary.StageSummary stages_summary = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Sleep.SleepSummary.StageSummary

getStagesSummaryCount()

public abstract int getStagesSummaryCount()

Output only. List of summaries (total duration and segment count) per each sleep stage type.

repeated .google.devicesandservices.health.v4.Sleep.SleepSummary.StageSummary stages_summary = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getStagesSummaryList()

public abstract List<Sleep.SleepSummary.StageSummary> getStagesSummaryList()

Output only. List of summaries (total duration and segment count) per each sleep stage type.

repeated .google.devicesandservices.health.v4.Sleep.SleepSummary.StageSummary stages_summary = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<StageSummary>

getStagesSummaryOrBuilder(int index)

public abstract Sleep.SleepSummary.StageSummaryOrBuilder getStagesSummaryOrBuilder(int index)

Output only. List of summaries (total duration and segment count) per each sleep stage type.

repeated .google.devicesandservices.health.v4.Sleep.SleepSummary.StageSummary stages_summary = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Sleep.SleepSummary.StageSummaryOrBuilder

getStagesSummaryOrBuilderList()

public abstract List<? extends Sleep.SleepSummary.StageSummaryOrBuilder> getStagesSummaryOrBuilderList()

Output only. List of summaries (total duration and segment count) per each sleep stage type.

repeated .google.devicesandservices.health.v4.Sleep.SleepSummary.StageSummary stages_summary = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.devicesandservices.health.v4.Sleep.SleepSummary.StageSummaryOrBuilder>

hasMinutesAfterWakeUp()

public abstract boolean hasMinutesAfterWakeUp()

Output only. Minutes after wake up calculated by restlessness algorithm.

optional int64 minutes_after_wake_up = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the minutesAfterWakeUp field is set.

hasMinutesAsleep()

public abstract boolean hasMinutesAsleep()

Output only. Total number of minutes asleep. For classic sleep it is the sum of ASLEEP stages (excluding AWAKE and RESTLESS). For "stages" sleep it is the sum of LIGHT, REM and DEEP stages (excluding AWAKE).

optional int64 minutes_asleep = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the minutesAsleep field is set.

hasMinutesAwake()

public abstract boolean hasMinutesAwake()

Output only. Total number of minutes awake. It is a sum of all AWAKE stages.

optional int64 minutes_awake = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the minutesAwake field is set.

hasMinutesInSleepPeriod()

public abstract boolean hasMinutesInSleepPeriod()

Output only. Delta between wake time and bedtime. It is the sum of all stages.

optional int64 minutes_in_sleep_period = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the minutesInSleepPeriod field is set.

hasMinutesToFallAsleep()

public abstract boolean hasMinutesToFallAsleep()

Output only. Minutes to fall asleep calculated by restlessness algorithm.

optional int64 minutes_to_fall_asleep = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the minutesToFallAsleep field is set.