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