Class: Record
Represents a Record.
Implements
Constructors
constructor
• new Record(properties?): Record
Constructs a new Record.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRecord | Properties to set |
Returns
Properties
type
• type: RecordType
Record type.
Implementation of
unit
• unit: RecordUnit
Record unit.
Implementation of
value
• value: number
Record value.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Record to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Record
Creates a new Record instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRecord | Properties to set |
Returns
Record instance
decode
▸ decode(reader, length?): Record
Decodes a Record 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
Record
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Record
Decodes a Record message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Record
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 Record message. Does not implicitly temporal.api.cloud.usage.v1.Record.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRecord | Record message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Record message, length delimited. Does not implicitly temporal.api.cloud.usage.v1.Record.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRecord | Record message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Record
Creates a Record message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Record
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Record
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 Record message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Record | Record |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object