Skip to main content

Class: GroupBy

Represents a GroupBy.

Properties​

key​

key: GroupByKey

GroupBy key.

value​

value: string

GroupBy value.

Methods​

toJSON()​

toJSON(): object

Converts this GroupBy to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): GroupBy & $Properties

Creates a new GroupBy instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

GroupBy & $Properties

GroupBy instance

Call Signature​

static create(properties?): GroupBy

Creates a new GroupBy instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

GroupBy

GroupBy instance

decode()​

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

Decodes a GroupBy 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​

GroupBy & $Properties

GroupBy

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): GroupBy & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

GroupBy & $Properties

GroupBy

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

Parameters​

message​

$Properties

GroupBy message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

GroupBy message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): GroupBy

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

GroupBy

GroupBy

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

GroupBy

GroupBy

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object