Class: LogRecord

auditlog.v1.LogRecord

LogRecord represents an audit log entry from Temporal, structured for easy parsing and analysis.

Implements

• ILogRecord

Constructors

constructor

• new LogRecord(properties?): LogRecord

Constructs a new LogRecord.

Parameters

Name	Type	Description
properties?	ILogRecord	Properties to set

Returns

LogRecord

Properties

asyncOperationId

• asyncOperationId: string

The ID of the async operation.

Implementation of

ILogRecord.asyncOperationId

---

emitTime

• Optional emitTime: null | ITimestamp

Time when the log was emitted.

Implementation of

ILogRecord.emitTime

---

logId

• logId: string

Unique ID for the log record.

Implementation of

ILogRecord.logId

---

operation

• operation: string

The operation performed.

Implementation of

ILogRecord.operation

---

principal

• Optional principal: null | IPrincipal

The principal that performed the operation.

Implementation of

ILogRecord.principal

---

rawDetails

• Optional rawDetails: null | IStruct

The raw details of the operation.

Implementation of

ILogRecord.rawDetails

---

status

• status: string

The status of the operation.

Implementation of

ILogRecord.status

---

version

• version: number

The internal version of the log message. Can be used in deduplication if needed.

Implementation of

ILogRecord.version

---

xForwardedFor

• xForwardedFor: string

The originating IP address of the request.

Implementation of

ILogRecord.xForwardedFor

Methods

toJSON

▸ toJSON(): Object

Converts this LogRecord to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): LogRecord

Creates a new LogRecord instance using the specified properties.

Parameters

Name	Type	Description
properties?	ILogRecord	Properties to set

Returns

LogRecord

LogRecord instance

---

decode

▸ decode(reader, length?): LogRecord

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

LogRecord

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): LogRecord

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

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	ILogRecord	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	ILogRecord	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

LogRecord

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for LogRecord

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 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