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: null | $Properties
The KinesisSpec when destination_type is Kinesis
name
• name: string
Name of the sink e.g. "audit_log_01"
pubSubSink
• Optional pubSubSink: null | $Properties
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
▸ create(properties?): AuditLogSinkSpec & $Shape
Creates a new AuditLogSinkSpec instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
AuditLogSinkSpec instance
▸ create(properties?): AuditLogSinkSpec
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): AuditLogSinkSpec & $Shape
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
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): AuditLogSinkSpec & $Shape
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
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 | $Properties | 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 | $Properties | 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
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