Skip to main content

Class: AuditLogSink

account.v1.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: null | $Properties

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

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​

▸ create(properties?): AuditLogSink & $Shape

Creates a new AuditLogSink instance using the specified properties.

Parameters​

NameTypeDescription
properties?$ShapeProperties to set

Returns​

AuditLogSink & $Shape

AuditLogSink instance

▸ create(properties?): AuditLogSink

Parameters​

NameType
properties?$Properties

Returns​

AuditLogSink


decode​

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

Decodes an AuditLogSink message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage 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​

▸ decodeDelimited(reader): AuditLogSink & $Shape

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader 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​

▸ encode(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesAuditLogSink message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesAuditLogSink message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): AuditLogSink

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

AuditLogSink

AuditLogSink


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageAuditLogSinkAuditLogSink
options?IConversionOptionsConversion options

Returns​

Object

Plain object