Class: NamespacedWorkflowExecution
coresdk.common.NamespacedWorkflowExecution
Identifying information about a particular workflow execution, including namespace
Implements
Constructors
constructor
• new NamespacedWorkflowExecution(properties?): NamespacedWorkflowExecution
Constructs a new NamespacedWorkflowExecution.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INamespacedWorkflowExecution | Properties to set |
Returns
Properties
namespace
• namespace: string
Namespace the workflow run is located in
Implementation of
INamespacedWorkflowExecution.namespace
runId
• runId: string
May be empty if the most recent run of the workflow with the given ID is being targeted
Implementation of
INamespacedWorkflowExecution.runId
workflowId
• workflowId: string
Can never be empty
Implementation of
INamespacedWorkflowExecution.workflowId
Methods
toJSON
▸ toJSON(): Object
Converts this NamespacedWorkflowExecution to JSON.
Returns
Object
JSON object
create
▸ create(properties?): NamespacedWorkflowExecution
Creates a new NamespacedWorkflowExecution instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INamespacedWorkflowExecution | Properties to set |
Returns
NamespacedWorkflowExecution instance
decode
▸ decode(reader, length?): NamespacedWorkflowExecution
Decodes a NamespacedWorkflowExecution 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
NamespacedWorkflowExecution
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): NamespacedWorkflowExecution
Decodes a NamespacedWorkflowExecution message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
NamespacedWorkflowExecution
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 NamespacedWorkflowExecution message. Does not implicitly coresdk.common.NamespacedWorkflowExecution.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INamespacedWorkflowExecution | NamespacedWorkflowExecution message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified NamespacedWorkflowExecution message, length delimited. Does not implicitly coresdk.common.NamespacedWorkflowExecution.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INamespacedWorkflowExecution | NamespacedWorkflowExecution message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): NamespacedWorkflowExecution
Creates a NamespacedWorkflowExecution message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
NamespacedWorkflowExecution
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for NamespacedWorkflowExecution
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 NamespacedWorkflowExecution message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | NamespacedWorkflowExecution | NamespacedWorkflowExecution |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object