Skip to main content

Class: Endpoints

Represents an Endpoints.

Properties​

grpcAddress​

grpcAddress: string

The gRPC address for API key client connections (may be empty if API keys are disabled).

mtlsGrpcAddress​

mtlsGrpcAddress: string

The gRPC address for mTLS client connections (may be empty if mTLS is disabled).

webAddress​

webAddress: string

The web UI address.

Methods​

toJSON()​

toJSON(): object

Converts this Endpoints to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Endpoints & $Properties

Creates a new Endpoints instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Endpoints & $Properties

Endpoints instance

Call Signature​

static create(properties?): Endpoints

Creates a new Endpoints instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Endpoints

Endpoints instance

decode()​

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

Decodes an Endpoints 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​

Endpoints & $Properties

Endpoints

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Endpoints & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Endpoints & $Properties

Endpoints

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

Parameters​

message​

$Properties

Endpoints message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

Endpoints message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Endpoints

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

Endpoints

Endpoints

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Endpoints

Endpoints

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object