Skip to main content

Class: GetWorkflowExecutionHistoryResponse

workflowservice.v1.GetWorkflowExecutionHistoryResponse

Represents a GetWorkflowExecutionHistoryResponse.

Implements#

Constructors#

constructor#

new GetWorkflowExecutionHistoryResponse(properties?)

Constructs a new GetWorkflowExecutionHistoryResponse.

Parameters#

NameType
properties?IGetWorkflowExecutionHistoryResponse

Properties#

archived#

archived: boolean

GetWorkflowExecutionHistoryResponse archived.

Implementation of#

IGetWorkflowExecutionHistoryResponse.archived


history#

Optional history: null | IHistory

GetWorkflowExecutionHistoryResponse history.

Implementation of#

IGetWorkflowExecutionHistoryResponse.history


nextPageToken#

nextPageToken: Uint8Array

GetWorkflowExecutionHistoryResponse nextPageToken.

Implementation of#

IGetWorkflowExecutionHistoryResponse.nextPageToken


rawHistory#

rawHistory: IDataBlob[]

GetWorkflowExecutionHistoryResponse rawHistory.

Implementation of#

IGetWorkflowExecutionHistoryResponse.rawHistory

Methods#

toJSON#

toJSON(): Object

Converts this GetWorkflowExecutionHistoryResponse to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): GetWorkflowExecutionHistoryResponse

Decodes a GetWorkflowExecutionHistoryResponse message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

GetWorkflowExecutionHistoryResponse

GetWorkflowExecutionHistoryResponse


decodeDelimited#

Static decodeDelimited(reader): GetWorkflowExecutionHistoryResponse

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

GetWorkflowExecutionHistoryResponse

GetWorkflowExecutionHistoryResponse


encode#

Static encode(message, writer?): Writer

Encodes the specified GetWorkflowExecutionHistoryResponse message. Does not implicitly {@link temporal.api.workflowservice.v1.GetWorkflowExecutionHistoryResponse.verify|verify} messages.

Parameters#

NameTypeDescription
messageIGetWorkflowExecutionHistoryResponseGetWorkflowExecutionHistoryResponse message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified GetWorkflowExecutionHistoryResponse message, length delimited. Does not implicitly {@link temporal.api.workflowservice.v1.GetWorkflowExecutionHistoryResponse.verify|verify} messages.

Parameters#

NameTypeDescription
messageIGetWorkflowExecutionHistoryResponseGetWorkflowExecutionHistoryResponse message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): GetWorkflowExecutionHistoryResponse

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

GetWorkflowExecutionHistoryResponse

GetWorkflowExecutionHistoryResponse


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageGetWorkflowExecutionHistoryResponseGetWorkflowExecutionHistoryResponse
options?IConversionOptions-

Returns#

Object

Plain object