Skip to main content

Class: RecordGroup

usage.v1.RecordGroup

Represents a RecordGroup.

Properties

groupBys

groupBys: $Properties[]

GroupBy keys and their values for this record group. Multiple fields are combined with logical AND.


records

records: $Properties[]

RecordGroup records.

Methods

toJSON

toJSON(): Object

Converts this RecordGroup to JSON.

Returns

Object

JSON object


create

create(properties?): RecordGroup & $Properties

Creates a new RecordGroup instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

RecordGroup & $Properties

RecordGroup instance

create(properties?): RecordGroup

Parameters

NameType
properties?$Properties

Returns

RecordGroup


decode

decode(reader, length?): RecordGroup & $Properties

Decodes a RecordGroup message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

RecordGroup & $Properties

RecordGroup

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): RecordGroup & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

RecordGroup & $Properties

RecordGroup

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 RecordGroup message. Does not implicitly temporal.api.cloud.usage.v1.RecordGroup.verify|verify messages.

Parameters

NameTypeDescription
message$PropertiesRecordGroup message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
message$PropertiesRecordGroup message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): RecordGroup

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

RecordGroup

RecordGroup


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageRecordGroupRecordGroup
options?IConversionOptionsConversion options

Returns

Object

Plain object