Skip to main content

Class: GetWorkflowExecutionHistoryRequest

workflowservice.v1.GetWorkflowExecutionHistoryRequest

Represents a GetWorkflowExecutionHistoryRequest.

Implements

Constructors

constructor

new GetWorkflowExecutionHistoryRequest(properties?)

Constructs a new GetWorkflowExecutionHistoryRequest.

Parameters

NameTypeDescription
properties?IGetWorkflowExecutionHistoryRequestProperties to set

Properties

execution

Optional execution: null | IWorkflowExecution

GetWorkflowExecutionHistoryRequest execution.

Implementation of

IGetWorkflowExecutionHistoryRequest.execution


historyEventFilterType

historyEventFilterType: HistoryEventFilterType

GetWorkflowExecutionHistoryRequest historyEventFilterType.

Implementation of

IGetWorkflowExecutionHistoryRequest.historyEventFilterType


maximumPageSize

maximumPageSize: number

GetWorkflowExecutionHistoryRequest maximumPageSize.

Implementation of

IGetWorkflowExecutionHistoryRequest.maximumPageSize


namespace

namespace: string

GetWorkflowExecutionHistoryRequest namespace.

Implementation of

IGetWorkflowExecutionHistoryRequest.namespace


nextPageToken

nextPageToken: Uint8Array

GetWorkflowExecutionHistoryRequest nextPageToken.

Implementation of

IGetWorkflowExecutionHistoryRequest.nextPageToken


skipArchival

skipArchival: boolean

GetWorkflowExecutionHistoryRequest skipArchival.

Implementation of

IGetWorkflowExecutionHistoryRequest.skipArchival


waitNewEvent

waitNewEvent: boolean

GetWorkflowExecutionHistoryRequest waitNewEvent.

Implementation of

IGetWorkflowExecutionHistoryRequest.waitNewEvent

Methods

toJSON

toJSON(): Object

Converts this GetWorkflowExecutionHistoryRequest to JSON.

Returns

Object

JSON object


create

Static create(properties?): GetWorkflowExecutionHistoryRequest

Creates a new GetWorkflowExecutionHistoryRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IGetWorkflowExecutionHistoryRequestProperties to set

Returns

GetWorkflowExecutionHistoryRequest

GetWorkflowExecutionHistoryRequest instance


decode

Static decode(reader, length?): GetWorkflowExecutionHistoryRequest

Decodes a GetWorkflowExecutionHistoryRequest message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

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

Returns

GetWorkflowExecutionHistoryRequest

GetWorkflowExecutionHistoryRequest


decodeDelimited

Static decodeDelimited(reader): GetWorkflowExecutionHistoryRequest

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

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

GetWorkflowExecutionHistoryRequest

GetWorkflowExecutionHistoryRequest


encode

Static encode(message, writer?): Writer

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

Parameters

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

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

NameTypeDescription
objectObjectPlain object

Returns

GetWorkflowExecutionHistoryRequest

GetWorkflowExecutionHistoryRequest


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for GetWorkflowExecutionHistoryRequest

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

Static toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageGetWorkflowExecutionHistoryRequestGetWorkflowExecutionHistoryRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object