Skip to main content

Class: AuditLogSinkSpec

AuditLogSinkSpec is only used by Audit Log

Properties​

enabled​

enabled: boolean

Enabled indicates whether the sink is enabled or not.

kinesisSink?​

optional kinesisSink?: $Properties | null

The KinesisSpec when destination_type is Kinesis

name​

name: string

Name of the sink e.g. "audit_log_01"

pubSubSink?​

optional pubSubSink?: $Properties | null

The PubSubSpec when destination_type is PubSub

sinkType?​

optional sinkType?: "kinesisSink" | "pubSubSink"

AuditLogSinkSpec sinkType.

Methods​

toJSON()​

toJSON(): object

Converts this AuditLogSinkSpec to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): AuditLogSinkSpec & $Shape

Creates a new AuditLogSinkSpec instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

AuditLogSinkSpec & $Shape

AuditLogSinkSpec instance

Call Signature​

static create(properties?): AuditLogSinkSpec

Creates a new AuditLogSinkSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

AuditLogSinkSpec

AuditLogSinkSpec instance

decode()​

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

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

AuditLogSinkSpec & $Shape

AuditLogSinkSpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): AuditLogSinkSpec & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

AuditLogSinkSpec & $Shape

AuditLogSinkSpec

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

Parameters​

message​

$Properties

AuditLogSinkSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

AuditLogSinkSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): AuditLogSinkSpec

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

AuditLogSinkSpec

AuditLogSinkSpec

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

AuditLogSinkSpec

AuditLogSinkSpec

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object