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