Class: Operation
v1.ExecuteMultiOperationRequest.Operation
Represents an Operation.
Implements
Constructors
constructor
• new Operation(properties?): Operation
Constructs a new Operation.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IOperation | Properties to set |
Returns
Properties
operation
• Optional operation: "startWorkflow" | "updateWorkflow"
Operation operation.
startWorkflow
• Optional startWorkflow: null | IStartWorkflowExecutionRequest
Additional restrictions:
- setting
cron_scheduleis invalid - setting
request_eager_executionis invalid
Implementation of
updateWorkflow
• Optional updateWorkflow: null | IUpdateWorkflowExecutionRequest
Operation updateWorkflow.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Operation to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Operation
Creates a new Operation instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IOperation | Properties to set |
Returns
Operation instance
decode
▸ decode(reader, length?): Operation
Decodes an Operation 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
Operation
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Operation
Decodes an Operation message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Operation
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 Operation message. Does not implicitly temporal.api.workflowservice.v1.ExecuteMultiOperationRequest.Operation.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IOperation | Operation message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Operation message, length delimited. Does not implicitly temporal.api.workflowservice.v1.ExecuteMultiOperationRequest.Operation.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IOperation | Operation message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Operation
Creates an Operation message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Operation
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Operation
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 Operation message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Operation | Operation |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object