Class: UnsuccessfulOperationError
nexus.v1.UnsuccessfulOperationError
Represents an UnsuccessfulOperationError.
Implements
Constructors
constructor
• new UnsuccessfulOperationError(properties?): UnsuccessfulOperationError
Constructs a new UnsuccessfulOperationError.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUnsuccessfulOperationError | Properties to set |
Returns
Properties
failure
• Optional failure: null | IFailure
UnsuccessfulOperationError failure.
Implementation of
IUnsuccessfulOperationError.failure
operationState
• operationState: string
See https://github.com/nexus-rpc/api/blob/main/SPEC.md#operationinfo.
Implementation of
IUnsuccessfulOperationError.operationState
Methods
toJSON
▸ toJSON(): Object
Converts this UnsuccessfulOperationError to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UnsuccessfulOperationError
Creates a new UnsuccessfulOperationError instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUnsuccessfulOperationError | Properties to set |
Returns
UnsuccessfulOperationError instance
decode
▸ decode(reader, length?): UnsuccessfulOperationError
Decodes an UnsuccessfulOperationError 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
UnsuccessfulOperationError
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UnsuccessfulOperationError
Decodes an UnsuccessfulOperationError message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UnsuccessfulOperationError
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 UnsuccessfulOperationError message. Does not implicitly temporal.api.nexus.v1.UnsuccessfulOperationError.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUnsuccessfulOperationError | UnsuccessfulOperationError message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UnsuccessfulOperationError message, length delimited. Does not implicitly temporal.api.nexus.v1.UnsuccessfulOperationError.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUnsuccessfulOperationError | UnsuccessfulOperationError message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UnsuccessfulOperationError
Creates an UnsuccessfulOperationError message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UnsuccessfulOperationError
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for UnsuccessfulOperationError
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 an UnsuccessfulOperationError message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UnsuccessfulOperationError | UnsuccessfulOperationError |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object