Class: RecordGroup
Represents a RecordGroup.
Implements
Constructors
constructor
• new RecordGroup(properties?): RecordGroup
Constructs a new RecordGroup.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRecordGroup | Properties to set |
Returns
Properties
groupBys
• groupBys: IGroupBy[]
GroupBy keys and their values for this record group. Multiple fields are combined with logical AND.
Implementation of
records
• records: IRecord[]
RecordGroup records.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this RecordGroup to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RecordGroup
Creates a new RecordGroup instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRecordGroup | Properties to set |
Returns
RecordGroup instance
decode
▸ decode(reader, length?): RecordGroup
Decodes a RecordGroup 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
RecordGroup
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RecordGroup
Decodes a RecordGroup message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
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
| Name | Type | Description |
|---|---|---|
message | IRecordGroup | RecordGroup message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
message | IRecordGroup | RecordGroup message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RecordGroup
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for RecordGroup
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 RecordGroup message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RecordGroup | RecordGroup |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object