Class: RespondActivityTaskFailedByIdRequest
workflowservice.v1.RespondActivityTaskFailedByIdRequest
Represents a RespondActivityTaskFailedByIdRequest.
Implements
Constructors
constructor
• new RespondActivityTaskFailedByIdRequest(properties?): RespondActivityTaskFailedByIdRequest
Constructs a new RespondActivityTaskFailedByIdRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRespondActivityTaskFailedByIdRequest | Properties to set |
Returns
RespondActivityTaskFailedByIdRequest
Properties
activityId
• activityId: string
Id of the activity to fail
Implementation of
IRespondActivityTaskFailedByIdRequest.activityId
failure
• Optional failure: null | IFailure
Detailed failure information
Implementation of
IRespondActivityTaskFailedByIdRequest.failure
identity
• identity: string
The identity of the worker/client
Implementation of
IRespondActivityTaskFailedByIdRequest.identity
lastHeartbeatDetails
• Optional lastHeartbeatDetails: null | IPayloads
Additional details to be stored as last activity heartbeat
Implementation of
IRespondActivityTaskFailedByIdRequest.lastHeartbeatDetails
namespace
• namespace: string
Namespace of the workflow which scheduled this activity
Implementation of
IRespondActivityTaskFailedByIdRequest.namespace
runId
• runId: string
Run Id of the workflow which scheduled this activity
Implementation of
IRespondActivityTaskFailedByIdRequest.runId
workflowId
• workflowId: string
Id of the workflow which scheduled this activity
Implementation of
IRespondActivityTaskFailedByIdRequest.workflowId
Methods
toJSON
▸ toJSON(): Object
Converts this RespondActivityTaskFailedByIdRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RespondActivityTaskFailedByIdRequest
Creates a new RespondActivityTaskFailedByIdRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRespondActivityTaskFailedByIdRequest | Properties to set |
Returns
RespondActivityTaskFailedByIdRequest
RespondActivityTaskFailedByIdRequest instance
decode
▸ decode(reader, length?): RespondActivityTaskFailedByIdRequest
Decodes a RespondActivityTaskFailedByIdRequest 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
RespondActivityTaskFailedByIdRequest
RespondActivityTaskFailedByIdRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RespondActivityTaskFailedByIdRequest
Decodes a RespondActivityTaskFailedByIdRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
RespondActivityTaskFailedByIdRequest
RespondActivityTaskFailedByIdRequest
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 RespondActivityTaskFailedByIdRequest message. Does not implicitly temporal.api.workflowservice.v1.RespondActivityTaskFailedByIdRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRespondActivityTaskFailedByIdRequest | RespondActivityTaskFailedByIdRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified RespondActivityTaskFailedByIdRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.RespondActivityTaskFailedByIdRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRespondActivityTaskFailedByIdRequest | RespondActivityTaskFailedByIdRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): RespondActivityTaskFailedByIdRequest
Creates a RespondActivityTaskFailedByIdRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RespondActivityTaskFailedByIdRequest
RespondActivityTaskFailedByIdRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for RespondActivityTaskFailedByIdRequest
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 a RespondActivityTaskFailedByIdRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RespondActivityTaskFailedByIdRequest | RespondActivityTaskFailedByIdRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object