Skip to main content

Class: 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. --)

Properties​

code​

code: number

OperationStatus code.

details​

details: $Properties[]

OperationStatus details.

message​

message: string

OperationStatus message.

Methods​

toJSON()​

toJSON(): object

Converts this OperationStatus to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): OperationStatus & $Properties

Creates a new OperationStatus instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

OperationStatus & $Properties

OperationStatus instance

Call Signature​

static create(properties?): OperationStatus

Creates a new OperationStatus instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

OperationStatus

OperationStatus instance

decode()​

static decode(reader, length?): OperationStatus & $Properties

Decodes an OperationStatus message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

OperationStatus & $Properties

OperationStatus

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): OperationStatus & $Properties

Decodes an OperationStatus message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

OperationStatus & $Properties

OperationStatus

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified OperationStatus message. Does not implicitly temporal.api.errordetails.v1.MultiOperationExecutionFailure.OperationStatus.verify|verify messages.

Parameters​

message​

$Properties

OperationStatus message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified OperationStatus message, length delimited. Does not implicitly temporal.api.errordetails.v1.MultiOperationExecutionFailure.OperationStatus.verify|verify messages.

Parameters​

message​

$Properties

OperationStatus message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): OperationStatus

Creates an OperationStatus message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

OperationStatus

OperationStatus

toObject()​

static toObject(message, options?): object

Creates a plain object from an OperationStatus message. Also converts values to other types if specified.

Parameters​

message​

OperationStatus

OperationStatus

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object