Class: AuditLogSinkSpec

account.v1.AuditLogSinkSpec

AuditLogSinkSpec is only used by Audit Log

Implements

• IAuditLogSinkSpec

Constructors

constructor

• new AuditLogSinkSpec(properties?): AuditLogSinkSpec

Constructs a new AuditLogSinkSpec.

Parameters

Name	Type	Description
properties?	IAuditLogSinkSpec	Properties to set

Returns

AuditLogSinkSpec

Properties

enabled

• enabled: boolean

Enabled indicates whether the sink is enabled or not.

Implementation of

IAuditLogSinkSpec.enabled

---

kinesisSink

• Optional kinesisSink: null | IKinesisSpec

The KinesisSpec when destination_type is Kinesis

Implementation of

IAuditLogSinkSpec.kinesisSink

---

name

• name: string

Name of the sink e.g. "audit_log_01"

Implementation of

IAuditLogSinkSpec.name

---

pubSubSink

• Optional pubSubSink: null | IPubSubSpec

The PubSubSpec when destination_type is PubSub

Implementation of

IAuditLogSinkSpec.pubSubSink

---

sinkType

• Optional sinkType: "kinesisSink" | "pubSubSink"

AuditLogSinkSpec sinkType.

Methods

toJSON

▸ toJSON(): Object

Converts this AuditLogSinkSpec to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): AuditLogSinkSpec

Creates a new AuditLogSinkSpec instance using the specified properties.

Parameters

Name	Type	Description
properties?	IAuditLogSinkSpec	Properties to set

Returns

AuditLogSinkSpec

AuditLogSinkSpec instance

---

decode

▸ decode(reader, length?): AuditLogSinkSpec

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

AuditLogSinkSpec

AuditLogSinkSpec

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): AuditLogSinkSpec

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

AuditLogSinkSpec

AuditLogSinkSpec

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

Parameters

Name	Type	Description
message	IAuditLogSinkSpec	AuditLogSinkSpec message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IAuditLogSinkSpec	AuditLogSinkSpec message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): AuditLogSinkSpec

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

AuditLogSinkSpec

AuditLogSinkSpec

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for AuditLogSinkSpec

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 an AuditLogSinkSpec message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	AuditLogSinkSpec	AuditLogSinkSpec
options?	IConversionOptions	Conversion options

Returns

Object

Plain object