Class: Execution
Identifies a specific execution within a namespace. This is used for standalone activities executions in batch jobs currently.
Implements
Constructors
constructor
• new Execution(properties?): Execution
Constructs a new Execution.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IExecution | Properties to set |
Returns
Properties
businessId
• businessId: string
Execution businessId.
Implementation of
runId
• runId: string
Execution runId.
Implementation of
type
• type: ExecutionType
Execution type.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Execution to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Execution
Creates a new Execution instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IExecution | Properties to set |
Returns
Execution instance
decode
▸ decode(reader, length?): Execution
Decodes an Execution 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
Execution
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Execution
Decodes an Execution message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Execution
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 Execution message. Does not implicitly temporal.api.common.v1.Execution.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IExecution | Execution message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Execution message, length delimited. Does not implicitly temporal.api.common.v1.Execution.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IExecution | Execution message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Execution
Creates an Execution message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Execution
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Execution
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 Execution message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Execution | Execution |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object