Class: Summary

usage.v1.Summary

Represents a Summary.

Implements

• ISummary

Constructors

constructor

• new Summary(properties?): Summary

Constructs a new Summary.

Parameters

Name	Type	Description
properties?	ISummary	Properties to set

Returns

Summary

Properties

endTime

• Optional endTime: null | ITimestamp

End of UTC day for now (exclusive)

Implementation of

ISummary.endTime

---

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)

Implementation of

ISummary.incomplete

---

recordGroups

• recordGroups: IRecordGroup[]

Records grouped by namespace

Implementation of

ISummary.recordGroups

---

startTime

• Optional startTime: null | ITimestamp

Start of UTC day for now (inclusive)

Implementation of

ISummary.startTime

Methods

toJSON

▸ toJSON(): Object

Converts this Summary to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): Summary

Creates a new Summary instance using the specified properties.

Parameters

Name	Type	Description
properties?	ISummary	Properties to set

Returns

Summary

Summary instance

---

decode

▸ decode(reader, length?): Summary

Decodes a Summary message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

Summary

Summary

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): Summary

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

Summary

Summary

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode

▸ encode(message, writer?): Writer

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

Parameters

Name	Type	Description
message	ISummary	Summary message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	ISummary	Summary message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): Summary

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

Summary

Summary

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Summary

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	Summary	Summary
options?	IConversionOptions	Conversion options

Returns

Object

Plain object