Class: AuditLogSink

account.v1.AuditLogSink

AuditLogSink is only used by Audit Log

Implements

• IAuditLogSink

Constructors

constructor

• new AuditLogSink(properties?): AuditLogSink

Constructs a new AuditLogSink.

Parameters

Name	Type	Description
properties?	IAuditLogSink	Properties to set

Returns

AuditLogSink

Properties

errorMessage

• errorMessage: string

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

Implementation of

IAuditLogSink.errorMessage

---

health

• health: Health

The health status of the audit log sink.

Implementation of

IAuditLogSink.health

---

lastSucceededTime

• Optional lastSucceededTime: null | ITimestamp

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

Implementation of

IAuditLogSink.lastSucceededTime

---

name

• name: string

Name of the sink e.g. "audit_log_01"

Implementation of

IAuditLogSink.name

---

resourceVersion

• resourceVersion: string

The version of the audit log sink resource.

Implementation of

IAuditLogSink.resourceVersion

---

spec

• Optional spec: null | IAuditLogSinkSpec

The specification details of the audit log sink.

Implementation of

IAuditLogSink.spec

---

state

• state: ResourceState

The current state of the audit log sink.

Implementation of

IAuditLogSink.state

Methods

toJSON

▸ toJSON(): Object

Converts this AuditLogSink to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): AuditLogSink

Creates a new AuditLogSink instance using the specified properties.

Parameters

Name	Type	Description
properties?	IAuditLogSink	Properties to set

Returns

AuditLogSink

AuditLogSink instance

---

decode

▸ decode(reader, length?): AuditLogSink

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

AuditLogSink

AuditLogSink

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): AuditLogSink

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

Parameters

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

Returns

AuditLogSink

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

Name	Type	Description
message	IAuditLogSink	AuditLogSink message or plain object to encode
writer?	Writer	Writer 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

Name	Type	Description
message	IAuditLogSink	AuditLogSink message or plain object to encode
writer?	Writer	Writer 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

Name	Type	Description
object	Object	Plain object

Returns

AuditLogSink

AuditLogSink

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for AuditLogSink

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

Parameters

Name	Type	Description
message	AuditLogSink	AuditLogSink
options?	IConversionOptions	Conversion options

Returns

Object

Plain object