Skip to main content

Class: WaitPolicy

update.v1.WaitPolicy

Specifies to the gRPC server how long the client wants the an update-related RPC call to wait before returning control to the caller.

Implements

Constructors

constructor

new WaitPolicy(properties?): WaitPolicy

Constructs a new WaitPolicy.

Parameters

NameTypeDescription
properties?IWaitPolicyProperties to set

Returns

WaitPolicy

Properties

lifecycleStage

lifecycleStage: UpdateWorkflowExecutionLifecycleStage

Indicates the update lifecycle stage that the gRPC call should wait for before returning.

Implementation of

IWaitPolicy.lifecycleStage

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

NameTypeDescription
properties?IWaitPolicyProperties to set

Returns

WaitPolicy

WaitPolicy instance


decode

decode(reader, length?): WaitPolicy

Decodes a WaitPolicy message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

WaitPolicy

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

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

WaitPolicy

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

NameTypeDescription
messageIWaitPolicyWaitPolicy message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
messageIWaitPolicyWaitPolicy message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
objectObjectPlain object

Returns

WaitPolicy

WaitPolicy


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for WaitPolicy

Parameters

NameTypeDescription
typeUrlPrefix?stringyour 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

NameTypeDescription
messageWaitPolicyWaitPolicy
options?IConversionOptionsConversion options

Returns

Object

Plain object