Class: LogRecord
LogRecord represents an audit log entry from Temporal, structured for easy parsing and analysis.
Properties
asyncOperationId
• asyncOperationId: string
The ID of the async operation.
emitTime
• Optional emitTime: null | $Properties
Time when the log was emitted.
logId
• logId: string
Unique ID for the log record.
operation
• operation: string
The operation performed.
principal
• Optional principal: null | $Properties
The principal that performed the operation.
rawDetails
• Optional rawDetails: null | $Properties
The raw details of the operation.
status
• status: string
The status of the operation.
version
• version: number
The internal version of the log message. Can be used in deduplication if needed.
xForwardedFor
• xForwardedFor: string
The originating IP address of the request.
Methods
toJSON
▸ toJSON(): Object
Converts this LogRecord to JSON.
Returns
Object
JSON object
create
▸ create(properties?): LogRecord & $Shape
Creates a new LogRecord instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
LogRecord instance
▸ create(properties?): LogRecord
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): LogRecord & $Shape
Decodes a LogRecord 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
LogRecord
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): LogRecord & $Shape
Decodes a LogRecord message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
LogRecord
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 LogRecord message. Does not implicitly temporal.api.cloud.auditlog.v1.LogRecord.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | LogRecord message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified LogRecord message, length delimited. Does not implicitly temporal.api.cloud.auditlog.v1.LogRecord.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | LogRecord message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): LogRecord
Creates a LogRecord message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
LogRecord
toObject
▸ toObject(message, options?): Object
Creates a plain object from a LogRecord message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | LogRecord | LogRecord |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object