Skip to main content

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?: $Properties | null

Time when the log was emitted.

logId​

logId: string

Unique ID for the log record.

operation​

operation: string

The operation performed.

principal?​

optional principal?: $Properties | null

The principal that performed the operation.

rawDetails?​

optional rawDetails?: $Properties | null

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()​

Call Signature​

static create(properties?): LogRecord & $Shape

Creates a new LogRecord instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

LogRecord & $Shape

LogRecord instance

Call Signature​

static create(properties?): LogRecord

Creates a new LogRecord instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

LogRecord

LogRecord instance

decode()​

static decode(reader, length?): LogRecord & $Shape

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

LogRecord & $Shape

LogRecord

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): LogRecord & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

LogRecord & $Shape

LogRecord

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

Parameters​

message​

$Properties

LogRecord message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

LogRecord message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): LogRecord

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

LogRecord

LogRecord

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

LogRecord

LogRecord

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object