Skip to main content

Class: CustomErrorMessage

Represents a CustomErrorMessage.

Properties​

default?​

optional default?: $Properties | null

The error message to display by default for any remote codec server errors.

Methods​

toJSON()​

toJSON(): object

Converts this CustomErrorMessage to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CustomErrorMessage & $Properties

Creates a new CustomErrorMessage instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CustomErrorMessage & $Properties

CustomErrorMessage instance

Call Signature​

static create(properties?): CustomErrorMessage

Creates a new CustomErrorMessage instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CustomErrorMessage

CustomErrorMessage instance

decode()​

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

Decodes a CustomErrorMessage 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​

CustomErrorMessage & $Properties

CustomErrorMessage

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CustomErrorMessage & $Properties

Decodes a CustomErrorMessage message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CustomErrorMessage & $Properties

CustomErrorMessage

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 CustomErrorMessage message. Does not implicitly temporal.api.cloud.namespace.v1.CodecServerSpec.CustomErrorMessage.verify|verify messages.

Parameters​

message​

$Properties

CustomErrorMessage message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified CustomErrorMessage message, length delimited. Does not implicitly temporal.api.cloud.namespace.v1.CodecServerSpec.CustomErrorMessage.verify|verify messages.

Parameters​

message​

$Properties

CustomErrorMessage message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CustomErrorMessage

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

CustomErrorMessage

CustomErrorMessage

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CustomErrorMessage

CustomErrorMessage

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object