Class: TerminatedFailureInfo
failure.v1.TerminatedFailureInfo
Represents a TerminatedFailureInfo.
Properties
identity
• identity: string
The identity of the worker or client that requested the termination.
Methods
toJSON
▸ toJSON(): Object
Converts this TerminatedFailureInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): TerminatedFailureInfo & $Properties
Creates a new TerminatedFailureInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
TerminatedFailureInfo & $Properties
TerminatedFailureInfo instance
▸ create(properties?): TerminatedFailureInfo
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): TerminatedFailureInfo & $Properties
Decodes a TerminatedFailureInfo 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
TerminatedFailureInfo & $Properties
TerminatedFailureInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): TerminatedFailureInfo & $Properties
Decodes a TerminatedFailureInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
TerminatedFailureInfo & $Properties
TerminatedFailureInfo
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 TerminatedFailureInfo message. Does not implicitly temporal.api.failure.v1.TerminatedFailureInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | TerminatedFailureInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified TerminatedFailureInfo message, length delimited. Does not implicitly temporal.api.failure.v1.TerminatedFailureInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | TerminatedFailureInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): TerminatedFailureInfo
Creates a TerminatedFailureInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
TerminatedFailureInfo
toObject
▸ toObject(message, options?): Object
Creates a plain object from a TerminatedFailureInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | TerminatedFailureInfo | TerminatedFailureInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object