Skip to main content

Class: Summary

Represents a Summary.

Properties​

endTime?​

optional endTime?: $Properties | null

End of UTC day for now (exclusive)

incomplete​

incomplete: boolean

True if data for given time window is not fully available yet (e.g. delays) When true, records for the given time range could still be added/updated in the future (until false)

recordGroups​

recordGroups: $Properties[]

Records grouped by namespace

startTime?​

optional startTime?: $Properties | null

Start of UTC day for now (inclusive)

Methods​

toJSON()​

toJSON(): object

Converts this Summary to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Summary & $Properties

Creates a new Summary instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Summary & $Properties

Summary instance

Call Signature​

static create(properties?): Summary

Creates a new Summary instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Summary

Summary instance

decode()​

static decode(reader, length?): Summary & $Properties

Decodes a Summary message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

Summary & $Properties

Summary

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Summary & $Properties

Decodes a Summary message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Summary & $Properties

Summary

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified Summary message. Does not implicitly temporal.api.cloud.usage.v1.Summary.verify|verify messages.

Parameters​

message​

$Properties

Summary message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified Summary message, length delimited. Does not implicitly temporal.api.cloud.usage.v1.Summary.verify|verify messages.

Parameters​

message​

$Properties

Summary message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Summary

Creates a Summary message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

Summary

Summary

toObject()​

static toObject(message, options?): object

Creates a plain object from a Summary message. Also converts values to other types if specified.

Parameters​

message​

Summary

Summary

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object