Skip to main content

Class: GetWorkflowExecutionHistoryRequest

Represents a GetWorkflowExecutionHistoryRequest.

Properties​

execution?​

optional execution?: $Properties | null

GetWorkflowExecutionHistoryRequest execution.

historyEventFilterType​

historyEventFilterType: HistoryEventFilterType

Filter returned events such that they match the specified filter type. Default: HISTORY_EVENT_FILTER_TYPE_ALL_EVENT.

maximumPageSize​

maximumPageSize: number

GetWorkflowExecutionHistoryRequest maximumPageSize.

namespace​

namespace: string

GetWorkflowExecutionHistoryRequest namespace.

nextPageToken​

nextPageToken: Uint8Array

If a GetWorkflowExecutionHistoryResponse or a PollWorkflowTaskQueueResponse had one of these, it should be passed here to fetch the next page.

skipArchival​

skipArchival: boolean

GetWorkflowExecutionHistoryRequest skipArchival.

waitNewEvent​

waitNewEvent: boolean

If set to true, the RPC call will not resolve until there is a new event which matches the history_event_filter_type, or a timeout is hit.

Methods​

toJSON()​

toJSON(): object

Converts this GetWorkflowExecutionHistoryRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): GetWorkflowExecutionHistoryRequest & $Properties

Creates a new GetWorkflowExecutionHistoryRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

GetWorkflowExecutionHistoryRequest & $Properties

GetWorkflowExecutionHistoryRequest instance

Call Signature​

static create(properties?): GetWorkflowExecutionHistoryRequest

Creates a new GetWorkflowExecutionHistoryRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

GetWorkflowExecutionHistoryRequest

GetWorkflowExecutionHistoryRequest instance

decode()​

static decode(reader, length?): GetWorkflowExecutionHistoryRequest & $Properties

Decodes a GetWorkflowExecutionHistoryRequest message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

GetWorkflowExecutionHistoryRequest & $Properties

GetWorkflowExecutionHistoryRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): GetWorkflowExecutionHistoryRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

GetWorkflowExecutionHistoryRequest & $Properties

GetWorkflowExecutionHistoryRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified GetWorkflowExecutionHistoryRequest message. Does not implicitly temporal.api.workflowservice.v1.GetWorkflowExecutionHistoryRequest.verify|verify messages.

Parameters​

message​

$Properties

GetWorkflowExecutionHistoryRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

GetWorkflowExecutionHistoryRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): GetWorkflowExecutionHistoryRequest

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

Parameters​

object​

Plain object

Returns​

GetWorkflowExecutionHistoryRequest

GetWorkflowExecutionHistoryRequest

toObject()​

static toObject(message, options?): object

Creates a plain object from a GetWorkflowExecutionHistoryRequest message. Also converts values to other types if specified.

Parameters​

message​

GetWorkflowExecutionHistoryRequest

GetWorkflowExecutionHistoryRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object