Class: GetWorkflowExecutionHistoryResponse
Represents a GetWorkflowExecutionHistoryResponse.
Properties
archived
archived:
boolean
GetWorkflowExecutionHistoryResponse archived.
history?
optionalhistory?:$Properties|null
GetWorkflowExecutionHistoryResponse history.
nextPageToken
nextPageToken:
Uint8Array
Will be set if there are more history events than were included in this response
propagatedNexusSerializationContext?
optionalpropagatedNexusSerializationContext?:$Properties|null
Serialization context propagated from the Nexus caller that started this run. Returned on the initial request (without next_page_token) when present. Clients should retain it across paginated responses, which may omit it.
rawHistory
rawHistory:
$Properties[]
Raw history is an alternate representation of history that may be returned if configured on
the frontend. This is not supported by all SDKs. Either this or history will be set.
Methods
toJSON()
toJSON():
object
Converts this GetWorkflowExecutionHistoryResponse to JSON.
Returns
object
JSON object
create()
Call Signature
staticcreate(properties?):GetWorkflowExecutionHistoryResponse&$Shape
Creates a new GetWorkflowExecutionHistoryResponse instance using the specified properties.
Parameters
properties?
Properties to set
Returns
GetWorkflowExecutionHistoryResponse & $Shape
GetWorkflowExecutionHistoryResponse instance
Call Signature
staticcreate(properties?):GetWorkflowExecutionHistoryResponse
Creates a new GetWorkflowExecutionHistoryResponse instance using the specified properties.
Parameters
properties?
Properties to set
Returns
GetWorkflowExecutionHistoryResponse
GetWorkflowExecutionHistoryResponse instance
decode()
staticdecode(reader,length?):GetWorkflowExecutionHistoryResponse&$Shape
Decodes a GetWorkflowExecutionHistoryResponse 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
GetWorkflowExecutionHistoryResponse & $Shape
GetWorkflowExecutionHistoryResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):GetWorkflowExecutionHistoryResponse&$Shape
Decodes a GetWorkflowExecutionHistoryResponse message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
Returns
GetWorkflowExecutionHistoryResponse & $Shape
GetWorkflowExecutionHistoryResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode()
staticencode(message,writer?):Writer
Encodes the specified GetWorkflowExecutionHistoryResponse message. Does not implicitly temporal.api.workflowservice.v1.GetWorkflowExecutionHistoryResponse.verify|verify messages.
Parameters
message
GetWorkflowExecutionHistoryResponse message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified GetWorkflowExecutionHistoryResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.GetWorkflowExecutionHistoryResponse.verify|verify messages.
Parameters
message
GetWorkflowExecutionHistoryResponse message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):GetWorkflowExecutionHistoryResponse
Creates a GetWorkflowExecutionHistoryResponse message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
GetWorkflowExecutionHistoryResponse
GetWorkflowExecutionHistoryResponse
toObject()
statictoObject(message,options?):object
Creates a plain object from a GetWorkflowExecutionHistoryResponse message. Also converts values to other types if specified.
Parameters
message
GetWorkflowExecutionHistoryResponse
GetWorkflowExecutionHistoryResponse
options?
IConversionOptions
Conversion options
Returns
object
Plain object