Class: StartActivityExecutionResponse
workflowservice.v1.StartActivityExecutionResponse
Represents a StartActivityExecutionResponse.
Implements
Constructors
constructor
• new StartActivityExecutionResponse(properties?): StartActivityExecutionResponse
Constructs a new StartActivityExecutionResponse.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IStartActivityExecutionResponse | Properties to set |
Returns
StartActivityExecutionResponse
Properties
runId
• runId: string
The run ID of the activity that was started - or used (via ACTIVITY_ID_CONFLICT_POLICY_USE_EXISTING).
Implementation of
IStartActivityExecutionResponse.runId
started
• started: boolean
If true, a new activity was started.
Implementation of
IStartActivityExecutionResponse.started
Methods
toJSON
▸ toJSON(): Object
Converts this StartActivityExecutionResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): StartActivityExecutionResponse
Creates a new StartActivityExecutionResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IStartActivityExecutionResponse | Properties to set |
Returns
StartActivityExecutionResponse
StartActivityExecutionResponse instance
decode
▸ decode(reader, length?): StartActivityExecutionResponse
Decodes a StartActivityExecutionResponse 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
StartActivityExecutionResponse
StartActivityExecutionResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): StartActivityExecutionResponse
Decodes a StartActivityExecutionResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
StartActivityExecutionResponse
StartActivityExecutionResponse
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 StartActivityExecutionResponse message. Does not implicitly temporal.api.workflowservice.v1.StartActivityExecutionResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IStartActivityExecutionResponse | StartActivityExecutionResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified StartActivityExecutionResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.StartActivityExecutionResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IStartActivityExecutionResponse | StartActivityExecutionResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): StartActivityExecutionResponse
Creates a StartActivityExecutionResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
StartActivityExecutionResponse
StartActivityExecutionResponse
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for StartActivityExecutionResponse
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 StartActivityExecutionResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | StartActivityExecutionResponse | StartActivityExecutionResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object