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