Class: NexusOperationExecutionListInfo
nexus.v1.NexusOperationExecutionListInfo
Limited Nexus operation information returned in the list response. When adding fields here, ensure that it is also present in NexusOperationExecutionInfo (note that it may already be present in NexusOperationExecutionInfo but not at the top-level).
Implements
Constructors
constructor
• new NexusOperationExecutionListInfo(properties?): NexusOperationExecutionListInfo
Constructs a new NexusOperationExecutionListInfo.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INexusOperationExecutionListInfo | Properties to set |
Returns
NexusOperationExecutionListInfo
Properties
closeTime
• Optional closeTime: null | ITimestamp
If the operation is in a terminal status, this field represents the time the operation transitioned to that status.
Implementation of
INexusOperationExecutionListInfo.closeTime
endpoint
• endpoint: string
Endpoint name.
Implementation of
INexusOperationExecutionListInfo.endpoint
executionDuration
• Optional executionDuration: null | IDuration
The difference between close time and scheduled time. This field is only populated if the operation is closed.
Implementation of
INexusOperationExecutionListInfo.executionDuration
operation
• operation: string
Operation name.
Implementation of
INexusOperationExecutionListInfo.operation
operationId
• operationId: string
A unique identifier of this operation within its namespace along with run ID (below).
Implementation of
INexusOperationExecutionListInfo.operationId
runId
• runId: string
The run ID of the standalone Nexus operation.
Implementation of
INexusOperationExecutionListInfo.runId
scheduleTime
• Optional scheduleTime: null | ITimestamp
Time the operation was originally scheduled via a StartNexusOperation request.
Implementation of
INexusOperationExecutionListInfo.scheduleTime
searchAttributes
• Optional searchAttributes: null | ISearchAttributes
Search attributes from the start request.
Implementation of
INexusOperationExecutionListInfo.searchAttributes
service
• service: string
Service name.
Implementation of
INexusOperationExecutionListInfo.service
stateTransitionCount
• stateTransitionCount: Long
Updated on terminal status.
Implementation of
INexusOperationExecutionListInfo.stateTransitionCount
status
• status: NexusOperationExecutionStatus
The status is updated once, when the operation is originally scheduled, and again when the operation reaches a terminal status.
Implementation of
INexusOperationExecutionListInfo.status
Methods
toJSON
▸ toJSON(): Object
Converts this NexusOperationExecutionListInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): NexusOperationExecutionListInfo
Creates a new NexusOperationExecutionListInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INexusOperationExecutionListInfo | Properties to set |
Returns
NexusOperationExecutionListInfo
NexusOperationExecutionListInfo instance
decode
▸ decode(reader, length?): NexusOperationExecutionListInfo
Decodes a NexusOperationExecutionListInfo 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
NexusOperationExecutionListInfo
NexusOperationExecutionListInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): NexusOperationExecutionListInfo
Decodes a NexusOperationExecutionListInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
NexusOperationExecutionListInfo
NexusOperationExecutionListInfo
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 NexusOperationExecutionListInfo message. Does not implicitly temporal.api.nexus.v1.NexusOperationExecutionListInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INexusOperationExecutionListInfo | NexusOperationExecutionListInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified NexusOperationExecutionListInfo message, length delimited. Does not implicitly temporal.api.nexus.v1.NexusOperationExecutionListInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INexusOperationExecutionListInfo | NexusOperationExecutionListInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): NexusOperationExecutionListInfo
Creates a NexusOperationExecutionListInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
NexusOperationExecutionListInfo
NexusOperationExecutionListInfo
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for NexusOperationExecutionListInfo
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a NexusOperationExecutionListInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | NexusOperationExecutionListInfo | NexusOperationExecutionListInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object