Class: OperationStatus
v1.MultiOperationExecutionFailure.OperationStatus
NOTE: OperationStatus is modelled after
google.rpc.Status.
(-- api-linter: core::0146::any=disabled aip.dev/not-precedent: details are meant to hold arbitrary payloads. --)
Implements
Constructors
constructor
• new OperationStatus(properties?): OperationStatus
Constructs a new OperationStatus.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IOperationStatus | Properties to set |
Returns
Properties
code
• code: number
OperationStatus code.
Implementation of
details
• details: IAny[]
OperationStatus details.
Implementation of
message
• message: string
OperationStatus message.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this OperationStatus to JSON.
Returns
Object
JSON object
create
▸ create(properties?): OperationStatus
Creates a new OperationStatus instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IOperationStatus | Properties to set |
Returns
OperationStatus instance
decode
▸ decode(reader, length?): OperationStatus
Decodes an OperationStatus 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
OperationStatus
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): OperationStatus
Decodes an OperationStatus message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
OperationStatus
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 OperationStatus message. Does not implicitly temporal.api.errordetails.v1.MultiOperationExecutionFailure.OperationStatus.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IOperationStatus | OperationStatus message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified OperationStatus message, length delimited. Does not implicitly temporal.api.errordetails.v1.MultiOperationExecutionFailure.OperationStatus.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IOperationStatus | OperationStatus message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): OperationStatus
Creates an OperationStatus message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
OperationStatus
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for OperationStatus
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 OperationStatus message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | OperationStatus | OperationStatus |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object