Class: StartOperationRequest
nexus.v1.StartOperationRequest
A request to start an operation.
Implements
Constructors
constructor
• new StartOperationRequest(properties?): StartOperationRequest
Constructs a new StartOperationRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IStartOperationRequest | Properties to set |
Returns
Properties
callback
• callback: string
Callback URL to call upon completion if the started operation is async.
Implementation of
IStartOperationRequest.callback
callbackHeader
• callbackHeader: Object
Header that is expected to be attached to the callback request when the operation completes.
Index signature
▪ [k: string]: string
Implementation of
IStartOperationRequest.callbackHeader
links
• links: ILink[]
Links contain caller information and can be attached to the operations started by the handler.
Implementation of
operation
• operation: string
Type of operation to start.
Implementation of
IStartOperationRequest.operation
payload
• Optional payload: null | IPayload
Full request body from the incoming HTTP request.
Implementation of
IStartOperationRequest.payload
requestId
• requestId: string
A request ID that can be used as an idempotentency key.
Implementation of
IStartOperationRequest.requestId
service
• service: string
Name of service to start the operation in.
Implementation of
IStartOperationRequest.service
Methods
toJSON
▸ toJSON(): Object
Converts this StartOperationRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): StartOperationRequest
Creates a new StartOperationRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IStartOperationRequest | Properties to set |
Returns
StartOperationRequest instance
decode
▸ decode(reader, length?): StartOperationRequest
Decodes a StartOperationRequest 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
StartOperationRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): StartOperationRequest
Decodes a StartOperationRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
StartOperationRequest
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 StartOperationRequest message. Does not implicitly temporal.api.nexus.v1.StartOperationRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IStartOperationRequest | StartOperationRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified StartOperationRequest message, length delimited. Does not implicitly temporal.api.nexus.v1.StartOperationRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IStartOperationRequest | StartOperationRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): StartOperationRequest
Creates a StartOperationRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
StartOperationRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for StartOperationRequest
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 StartOperationRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | StartOperationRequest | StartOperationRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object