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: 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
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
AuditLogSink instance
▸ create(properties?): AuditLogSink
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): AuditLogSink & $Shape
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
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
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
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 | $Properties | 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 | $Properties | 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
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