Class: Request
A Nexus request.
Properties
cancelOperation
• Optional cancelOperation: null | $Properties
Request cancelOperation.
capabilities
• Optional capabilities: null | $Properties
Request capabilities.
endpoint
• endpoint: string
The endpoint this request was addressed to before forwarding to the worker. Supported from server version 1.30.0.
header
• header: Object
Headers extracted from the original request in the Temporal frontend. When using Nexus over HTTP, this includes the request's HTTP headers ignoring multiple values.
Index signature
▪ [k: string]: string
scheduledTime
• Optional scheduledTime: null | $Properties
The timestamp when the request was scheduled in the frontend. (-- api-linter: core::0142::time-field-names=disabled aip.dev/not-precedent: Not following linter rules. --)
startOperation
• Optional startOperation: null | $Properties
Request startOperation.
variant
• Optional variant: "startOperation" | "cancelOperation"
Request variant.
Methods
toJSON
▸ toJSON(): Object
Converts this Request to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Request & $Shape
Creates a new Request instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
Request instance
▸ create(properties?): Request
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): Request & $Shape
Decodes a Request 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
Request
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Request & $Shape
Decodes a Request message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Request
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 Request message. Does not implicitly temporal.api.nexus.v1.Request.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Request message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Request message, length delimited. Does not implicitly temporal.api.nexus.v1.Request.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Request message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Request
Creates a Request message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Request
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Request message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Request | Request |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object