Class: ActivityExecutionOutcome
activity.v1.ActivityExecutionOutcome
The outcome of a completed activity execution: either a successful result or a failure.
Implements
Constructors
constructor
• new ActivityExecutionOutcome(properties?): ActivityExecutionOutcome
Constructs a new ActivityExecutionOutcome.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IActivityExecutionOutcome | Properties to set |
Returns
Properties
failure
• Optional failure: null | IFailure
The failure if the activity completed unsuccessfully.
Implementation of
IActivityExecutionOutcome.failure
result
• Optional result: null | IPayloads
The result if the activity completed successfully.
Implementation of
IActivityExecutionOutcome.result
value
• Optional value: "failure" | "result"
ActivityExecutionOutcome value.
Methods
toJSON
▸ toJSON(): Object
Converts this ActivityExecutionOutcome to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ActivityExecutionOutcome
Creates a new ActivityExecutionOutcome instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IActivityExecutionOutcome | Properties to set |
Returns
ActivityExecutionOutcome instance
decode
▸ decode(reader, length?): ActivityExecutionOutcome
Decodes an ActivityExecutionOutcome 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
ActivityExecutionOutcome
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ActivityExecutionOutcome
Decodes an ActivityExecutionOutcome message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ActivityExecutionOutcome
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 ActivityExecutionOutcome message. Does not implicitly temporal.api.activity.v1.ActivityExecutionOutcome.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IActivityExecutionOutcome | ActivityExecutionOutcome message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ActivityExecutionOutcome message, length delimited. Does not implicitly temporal.api.activity.v1.ActivityExecutionOutcome.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IActivityExecutionOutcome | ActivityExecutionOutcome message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ActivityExecutionOutcome
Creates an ActivityExecutionOutcome message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ActivityExecutionOutcome
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ActivityExecutionOutcome
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 ActivityExecutionOutcome message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ActivityExecutionOutcome | ActivityExecutionOutcome |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object