Interface Sleep.SleepMetadataOrBuilder (0.8.0)

public static interface Sleep.SleepMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getExternalId()

public abstract String getExternalId()

Optional. Sleep identifier relevant in the context of the data source.

string external_id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The externalId.

getExternalIdBytes()

public abstract ByteString getExternalIdBytes()

Optional. Sleep identifier relevant in the context of the data source.

string external_id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for externalId.

getMainSleep()

public abstract boolean getMainSleep()

Output only. main_sleep: the longest sleep session with stages within one day. If no sleep session has stages, then the longest sleep is the main_sleep. If there are multiple days of sleep in the response, there is one main_sleep per day.

bool main_sleep = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	The mainSleep.

getManuallyEdited()

public abstract boolean getManuallyEdited()

Output only. Some sleeps autodetected by algorithms can be manually edited by users.

bool manually_edited = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	The manuallyEdited.

getNap()

public abstract boolean getNap()

Output only. Naps are sleeps without stages and relatively short durations.

bool nap = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	The nap.

getProcessed()

public abstract boolean getProcessed()

Output only. Sleep and sleep stages algorithms finished processing. A true value indicates whether all data processing for the session is complete. A false value means sleep period is detected but sleep stages is still processing.

bool processed = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	The processed.

getStagesStatus()

public abstract Sleep.SleepMetadata.StagesState getStagesStatus()

Output only. Sleep stages algorithm processing status.

.google.devicesandservices.health.v4.Sleep.SleepMetadata.StagesState stages_status = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Sleep.SleepMetadata.StagesState`	The stagesStatus.

getStagesStatusValue()

public abstract int getStagesStatusValue()