Class: StartOperationResponse
nexus.v1.StartOperationResponse
Response variant for StartOperationRequest.
Implements
Constructors
constructor
• new StartOperationResponse(properties?): StartOperationResponse
Constructs a new StartOperationResponse.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IStartOperationResponse | Properties to set |
Returns
Properties
asyncSuccess
• Optional asyncSuccess: null | IAsync
StartOperationResponse asyncSuccess.
Implementation of
IStartOperationResponse.asyncSuccess
failure
• Optional failure: null | IFailure
The operation completed unsuccessfully (failed or canceled). Failure object must contain an ApplicationFailureInfo or CanceledFailureInfo object.
Implementation of
IStartOperationResponse.failure
operationError
• Optional operationError: null | IUnsuccessfulOperationError
The operation completed unsuccessfully (failed or canceled). Deprecated. Use the failure variant instead.
Implementation of
IStartOperationResponse.operationError
syncSuccess
• Optional syncSuccess: null | ISync
StartOperationResponse syncSuccess.
Implementation of
IStartOperationResponse.syncSuccess
variant
• Optional variant: "failure" | "syncSuccess" | "asyncSuccess" | "operationError"
StartOperationResponse variant.
Methods
toJSON
▸ toJSON(): Object
Converts this StartOperationResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): StartOperationResponse
Creates a new StartOperationResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IStartOperationResponse | Properties to set |
Returns
StartOperationResponse instance
decode
▸ decode(reader, length?): StartOperationResponse
Decodes a StartOperationResponse 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
StartOperationResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): StartOperationResponse
Decodes a StartOperationResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
StartOperationResponse
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 StartOperationResponse message. Does not implicitly temporal.api.nexus.v1.StartOperationResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IStartOperationResponse | StartOperationResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified StartOperationResponse message, length delimited. Does not implicitly temporal.api.nexus.v1.StartOperationResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IStartOperationResponse | StartOperationResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): StartOperationResponse
Creates a StartOperationResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
StartOperationResponse
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for StartOperationResponse
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 StartOperationResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | StartOperationResponse | StartOperationResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object