Interface SleepOrBuilder (0.2.0)

public interface SleepOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Creation time of this sleep observation.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Creation time of this sleep observation.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getInterval()

public abstract SessionTimeInterval getInterval()

Required. Observed sleep interval.

.google.devicesandservices.health.v4.SessionTimeInterval interval = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SessionTimeInterval

The interval.

getIntervalOrBuilder()

public abstract SessionTimeIntervalOrBuilder getIntervalOrBuilder()

Required. Observed sleep interval.

.google.devicesandservices.health.v4.SessionTimeInterval interval = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SessionTimeIntervalOrBuilder

getMetadata()

public abstract Sleep.SleepMetadata getMetadata()

Optional. Sleep metadata: processing, main, manually edited, stages status.

.google.devicesandservices.health.v4.Sleep.SleepMetadata metadata = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Sleep.SleepMetadata

The metadata.

getMetadataOrBuilder()

public abstract Sleep.SleepMetadataOrBuilder getMetadataOrBuilder()

Optional. Sleep metadata: processing, main, manually edited, stages status.

.google.devicesandservices.health.v4.Sleep.SleepMetadata metadata = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Sleep.SleepMetadataOrBuilder

getOutOfBedSegments(int index)

public abstract Sleep.OutOfBedSegment getOutOfBedSegments(int index)

Optional. “Out of bed” segments that can overlap with sleep stages.

repeated .google.devicesandservices.health.v4.Sleep.OutOfBedSegment out_of_bed_segments = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Sleep.OutOfBedSegment

getOutOfBedSegmentsCount()

public abstract int getOutOfBedSegmentsCount()

Optional. “Out of bed” segments that can overlap with sleep stages.

repeated .google.devicesandservices.health.v4.Sleep.OutOfBedSegment out_of_bed_segments = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getOutOfBedSegmentsList()

public abstract List<Sleep.OutOfBedSegment> getOutOfBedSegmentsList()

Optional. “Out of bed” segments that can overlap with sleep stages.

repeated .google.devicesandservices.health.v4.Sleep.OutOfBedSegment out_of_bed_segments = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<OutOfBedSegment>

getOutOfBedSegmentsOrBuilder(int index)

public abstract Sleep.OutOfBedSegmentOrBuilder getOutOfBedSegmentsOrBuilder(int index)

Optional. “Out of bed” segments that can overlap with sleep stages.

repeated .google.devicesandservices.health.v4.Sleep.OutOfBedSegment out_of_bed_segments = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Sleep.OutOfBedSegmentOrBuilder

getOutOfBedSegmentsOrBuilderList()

public abstract List<? extends Sleep.OutOfBedSegmentOrBuilder> getOutOfBedSegmentsOrBuilderList()

Optional. “Out of bed” segments that can overlap with sleep stages.

repeated .google.devicesandservices.health.v4.Sleep.OutOfBedSegment out_of_bed_segments = 6 [(.google.api.field_behavior) = OPTIONAL];

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

getStages(int index)

public abstract Sleep.SleepStage getStages(int index)

Optional. List of non-overlapping contiguous sleep stage segments that cover the sleep period.

repeated .google.devicesandservices.health.v4.Sleep.SleepStage stages = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Sleep.SleepStage

getStagesCount()

public abstract int getStagesCount()

Optional. List of non-overlapping contiguous sleep stage segments that cover the sleep period.

repeated .google.devicesandservices.health.v4.Sleep.SleepStage stages = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getStagesList()

public abstract List<Sleep.SleepStage> getStagesList()

Optional. List of non-overlapping contiguous sleep stage segments that cover the sleep period.

repeated .google.devicesandservices.health.v4.Sleep.SleepStage stages = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<SleepStage>

getStagesOrBuilder(int index)

public abstract Sleep.SleepStageOrBuilder getStagesOrBuilder(int index)

Optional. List of non-overlapping contiguous sleep stage segments that cover the sleep period.

repeated .google.devicesandservices.health.v4.Sleep.SleepStage stages = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Sleep.SleepStageOrBuilder

getStagesOrBuilderList()

public abstract List<? extends Sleep.SleepStageOrBuilder> getStagesOrBuilderList()

Optional. List of non-overlapping contiguous sleep stage segments that cover the sleep period.

repeated .google.devicesandservices.health.v4.Sleep.SleepStage stages = 5 [(.google.api.field_behavior) = OPTIONAL];

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

getSummary()

public abstract Sleep.SleepSummary getSummary()

Output only. Sleep summary: metrics and stages summary.

.google.devicesandservices.health.v4.Sleep.SleepSummary summary = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Sleep.SleepSummary

The summary.

getSummaryOrBuilder()

public abstract Sleep.SleepSummaryOrBuilder getSummaryOrBuilder()

Output only. Sleep summary: metrics and stages summary.

.google.devicesandservices.health.v4.Sleep.SleepSummary summary = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Sleep.SleepSummaryOrBuilder

getType()

public abstract Sleep.SleepType getType()

Optional. SleepType: classic or stages.

.google.devicesandservices.health.v4.Sleep.SleepType type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Sleep.SleepType

The type.

getTypeValue()

public abstract int getTypeValue()

Optional. SleepType: classic or stages.

.google.devicesandservices.health.v4.Sleep.SleepType type = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for type.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Last update time of this sleep observation.

.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Last update time of this sleep observation.

.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Creation time of this sleep observation.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasInterval()

public abstract boolean hasInterval()

Required. Observed sleep interval.

.google.devicesandservices.health.v4.SessionTimeInterval interval = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the interval field is set.

hasMetadata()

public abstract boolean hasMetadata()

Optional. Sleep metadata: processing, main, manually edited, stages status.

.google.devicesandservices.health.v4.Sleep.SleepMetadata metadata = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the metadata field is set.

hasSummary()

public abstract boolean hasSummary()

Output only. Sleep summary: metrics and stages summary.

.google.devicesandservices.health.v4.Sleep.SleepSummary summary = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the summary field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Last update time of this sleep observation.

.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.