Skip to main content

Class: PollWorkflowExecutionTimeSkippingResponse

workflowservice.v1.PollWorkflowExecutionTimeSkippingResponse

Represents a PollWorkflowExecutionTimeSkippingResponse.

Implements

Constructors

constructor

new PollWorkflowExecutionTimeSkippingResponse(properties?): PollWorkflowExecutionTimeSkippingResponse

Constructs a new PollWorkflowExecutionTimeSkippingResponse.

Parameters

NameTypeDescription
properties?IPollWorkflowExecutionTimeSkippingResponseProperties to set

Returns

PollWorkflowExecutionTimeSkippingResponse

Properties

failedReason

failedReason: string

Set only when the result is FAST_FORWARD_POLLING_RESULT_FAST_FORWARD_FAILED; explains why the fast-forward can no longer complete.

Implementation of

IPollWorkflowExecutionTimeSkippingResponse.failedReason


fastForwardInfo

Optional fastForwardInfo: null | ITimeSkippingFastForwardInfo

The execution's current fast-forward, if any.

Implementation of

IPollWorkflowExecutionTimeSkippingResponse.fastForwardInfo


fastForwardPollingResult

fastForwardPollingResult: FastForwardPollingResult

The outcome of the poll for the fast-forward identified by the request's fast_forward_id.

Implementation of

IPollWorkflowExecutionTimeSkippingResponse.fastForwardPollingResult

Methods

toJSON

toJSON(): Object

Converts this PollWorkflowExecutionTimeSkippingResponse to JSON.

Returns

Object

JSON object


create

create(properties?): PollWorkflowExecutionTimeSkippingResponse

Creates a new PollWorkflowExecutionTimeSkippingResponse instance using the specified properties.

Parameters

NameTypeDescription
properties?IPollWorkflowExecutionTimeSkippingResponseProperties to set

Returns

PollWorkflowExecutionTimeSkippingResponse

PollWorkflowExecutionTimeSkippingResponse instance


decode

decode(reader, length?): PollWorkflowExecutionTimeSkippingResponse

Decodes a PollWorkflowExecutionTimeSkippingResponse message from the specified reader or buffer.

Parameters

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

Returns

PollWorkflowExecutionTimeSkippingResponse

PollWorkflowExecutionTimeSkippingResponse

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): PollWorkflowExecutionTimeSkippingResponse

Decodes a PollWorkflowExecutionTimeSkippingResponse message from the specified reader or buffer, length delimited.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

PollWorkflowExecutionTimeSkippingResponse

PollWorkflowExecutionTimeSkippingResponse

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 PollWorkflowExecutionTimeSkippingResponse message. Does not implicitly temporal.api.workflowservice.v1.PollWorkflowExecutionTimeSkippingResponse.verify|verify messages.

Parameters

NameTypeDescription
messageIPollWorkflowExecutionTimeSkippingResponsePollWorkflowExecutionTimeSkippingResponse message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

Encodes the specified PollWorkflowExecutionTimeSkippingResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.PollWorkflowExecutionTimeSkippingResponse.verify|verify messages.

Parameters

NameTypeDescription
messageIPollWorkflowExecutionTimeSkippingResponsePollWorkflowExecutionTimeSkippingResponse message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): PollWorkflowExecutionTimeSkippingResponse

Creates a PollWorkflowExecutionTimeSkippingResponse message from a plain object. Also converts values to their respective internal types.

Parameters

NameTypeDescription
objectObjectPlain object

Returns

PollWorkflowExecutionTimeSkippingResponse

PollWorkflowExecutionTimeSkippingResponse


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for PollWorkflowExecutionTimeSkippingResponse

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 PollWorkflowExecutionTimeSkippingResponse message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messagePollWorkflowExecutionTimeSkippingResponsePollWorkflowExecutionTimeSkippingResponse
options?IConversionOptionsConversion options

Returns

Object

Plain object