Represents a Sleep.
Implements
Package
@google-cloud/healthConstructors
(constructor)(properties)
constructor(properties?: google.devicesandservices.health.v4.ISleep);Constructs a new Sleep.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISleep
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);Sleep createTime.
interval
public interval?: (google.devicesandservices.health.v4.ISessionTimeInterval|null);Sleep interval.
metadata
public metadata?: (google.devicesandservices.health.v4.Sleep.ISleepMetadata|null);Sleep metadata.
outOfBedSegments
public outOfBedSegments: google.devicesandservices.health.v4.Sleep.IOutOfBedSegment[];Sleep outOfBedSegments.
shortAwakenings
public shortAwakenings: google.devicesandservices.health.v4.Sleep.ISleepStage[];Sleep shortAwakenings.
stages
public stages: google.devicesandservices.health.v4.Sleep.ISleepStage[];Sleep stages.
summary
public summary?: (google.devicesandservices.health.v4.Sleep.ISleepSummary|null);Sleep summary.
type
public type: (google.devicesandservices.health.v4.Sleep.SleepType|keyof typeof google.devicesandservices.health.v4.Sleep.SleepType);Sleep type.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Sleep updateTime.
Methods
create(properties)
public static create(properties?: google.devicesandservices.health.v4.ISleep): google.devicesandservices.health.v4.Sleep;Creates a new Sleep instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISleep
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Sleep |
Sleep instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.devicesandservices.health.v4.Sleep;Decodes a Sleep message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Sleep |
Sleep |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.devicesandservices.health.v4.Sleep;Decodes a Sleep message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Sleep |
Sleep |
encode(message, writer)
public static encode(message: google.devicesandservices.health.v4.ISleep, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Sleep message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISleep
Sleep message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.devicesandservices.health.v4.ISleep, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Sleep message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISleep
Sleep message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.devicesandservices.health.v4.Sleep;Creates a Sleep message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Sleep |
Sleep |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Sleep
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Sleep to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.devicesandservices.health.v4.Sleep, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Sleep message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Sleep
Sleep |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Sleep message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|