Skip to main content

Class: CodecServerSpec

Represents a CodecServerSpec.

Properties​

customErrorMessage?​

optional customErrorMessage?: $Properties | null

A custom error message to display for remote codec server errors. temporal:versioning:min_version=v0.5.1

endpoint​

endpoint: string

The codec server endpoint.

includeCrossOriginCredentials​

includeCrossOriginCredentials: boolean

Whether to include cross-origin credentials.

passAccessToken​

passAccessToken: boolean

Whether to pass the user access token with your endpoint.

Methods​

toJSON()​

toJSON(): object

Converts this CodecServerSpec to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CodecServerSpec & $Properties

Creates a new CodecServerSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CodecServerSpec & $Properties

CodecServerSpec instance

Call Signature​

static create(properties?): CodecServerSpec

Creates a new CodecServerSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CodecServerSpec

CodecServerSpec instance

decode()​

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

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

CodecServerSpec & $Properties

CodecServerSpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CodecServerSpec & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CodecServerSpec & $Properties

CodecServerSpec

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

Parameters​

message​

$Properties

CodecServerSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

CodecServerSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CodecServerSpec

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

CodecServerSpec

CodecServerSpec

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CodecServerSpec

CodecServerSpec

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object