Skip to main content

Class: AuditLogSink

AuditLogSink is only used by Audit Log

Properties​

errorMessage​

errorMessage: string

An error message describing any issues with the audit log sink, if applicable.

health​

health: Health

The health status of the audit log sink.

lastSucceededTime?​

optional lastSucceededTime?: $Properties | null

The last succeeded timestamp for the internal workflow responsible for adding data to the sink.

name​

name: string

Name of the sink e.g. "audit_log_01"

resourceVersion​

resourceVersion: string

The version of the audit log sink resource.

spec?​

optional spec?: $Properties | null

The specification details of the audit log sink.

state​

state: ResourceState

The current state of the audit log sink.

Methods​

toJSON()​

toJSON(): object

Converts this AuditLogSink to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): AuditLogSink & $Shape

Creates a new AuditLogSink instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

AuditLogSink & $Shape

AuditLogSink instance

Call Signature​

static create(properties?): AuditLogSink

Creates a new AuditLogSink instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

AuditLogSink

AuditLogSink instance

decode()​

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

Decodes an AuditLogSink 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​

AuditLogSink & $Shape

AuditLogSink

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): AuditLogSink & $Shape

Decodes an AuditLogSink message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

AuditLogSink & $Shape

AuditLogSink

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

Parameters​

message​

$Properties

AuditLogSink message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

AuditLogSink message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): AuditLogSink

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

AuditLogSink

AuditLogSink

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

AuditLogSink

AuditLogSink

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object