Class: GetWorkflowExecutionHistoryResponse
workflowservice.v1.GetWorkflowExecutionHistoryResponse
Represents a GetWorkflowExecutionHistoryResponse.
Properties
archived
• archived: boolean
GetWorkflowExecutionHistoryResponse archived.
history
• Optional history: null | $Properties
GetWorkflowExecutionHistoryResponse history.
nextPageToken
• nextPageToken: Uint8Array
Will be set if there are more history events than were included in this response
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
▸ create(properties?): GetWorkflowExecutionHistoryResponse & $Shape
Creates a new GetWorkflowExecutionHistoryResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
GetWorkflowExecutionHistoryResponse & $Shape
GetWorkflowExecutionHistoryResponse instance
▸ create(properties?): GetWorkflowExecutionHistoryResponse
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
GetWorkflowExecutionHistoryResponse
decode
▸ decode(reader, length?): GetWorkflowExecutionHistoryResponse & $Shape
Decodes a GetWorkflowExecutionHistoryResponse message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | 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
▸ decodeDelimited(reader): GetWorkflowExecutionHistoryResponse & $Shape
Decodes a GetWorkflowExecutionHistoryResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | 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
▸ encode(message, writer?): Writer
Encodes the specified GetWorkflowExecutionHistoryResponse message. Does not implicitly temporal.api.workflowservice.v1.GetWorkflowExecutionHistoryResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | GetWorkflowExecutionHistoryResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified GetWorkflowExecutionHistoryResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.GetWorkflowExecutionHistoryResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | GetWorkflowExecutionHistoryResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): GetWorkflowExecutionHistoryResponse
Creates a GetWorkflowExecutionHistoryResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
GetWorkflowExecutionHistoryResponse
GetWorkflowExecutionHistoryResponse
toObject
▸ toObject(message, options?): Object
Creates a plain object from a GetWorkflowExecutionHistoryResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | GetWorkflowExecutionHistoryResponse | GetWorkflowExecutionHistoryResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object