Class: WaitPolicy
Specifies client's intent to wait for Update results.
Implements
Constructors
constructor
• new WaitPolicy(properties?): WaitPolicy
Constructs a new WaitPolicy.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWaitPolicy | Properties to set |
Returns
Properties
lifecycleStage
• lifecycleStage: UpdateWorkflowExecutionLifecycleStage
Indicates the Update lifecycle stage that the Update must reach before API call is returned. NOTE: This field works together with API call timeout which is limited by server timeout (maximum wait time). If server timeout is expired before user specified timeout, API call returns even if specified stage is not reached.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this WaitPolicy to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WaitPolicy
Creates a new WaitPolicy instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWaitPolicy | Properties to set |
Returns
WaitPolicy instance
decode
▸ decode(reader, length?): WaitPolicy
Decodes a WaitPolicy 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
WaitPolicy
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WaitPolicy
Decodes a WaitPolicy message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WaitPolicy
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 WaitPolicy message. Does not implicitly temporal.api.update.v1.WaitPolicy.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWaitPolicy | WaitPolicy message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WaitPolicy message, length delimited. Does not implicitly temporal.api.update.v1.WaitPolicy.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWaitPolicy | WaitPolicy message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WaitPolicy
Creates a WaitPolicy message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WaitPolicy
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WaitPolicy
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 WaitPolicy message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WaitPolicy | WaitPolicy |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object