Skip to main content

Class: External

v1.EndpointTarget.External

Target an external server by URL. At a later point, this will support providing credentials, in the meantime, an http.RoundTripper can be injected into the server to modify the request.

Implements

Constructors

constructor

new External(properties?): External

Constructs a new External.

Parameters

NameTypeDescription
properties?IExternalProperties to set

Returns

External

Properties

url

url: string

URL to call.

Implementation of

IExternal.url

Methods

toJSON

toJSON(): Object

Converts this External to JSON.

Returns

Object

JSON object


create

create(properties?): External

Creates a new External instance using the specified properties.

Parameters

NameTypeDescription
properties?IExternalProperties to set

Returns

External

External instance


decode

decode(reader, length?): External

Decodes an External message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

External

External

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): External

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

External

External

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 External message. Does not implicitly temporal.api.nexus.v1.EndpointTarget.External.verify|verify messages.

Parameters

NameTypeDescription
messageIExternalExternal message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

Encodes the specified External message, length delimited. Does not implicitly temporal.api.nexus.v1.EndpointTarget.External.verify|verify messages.

Parameters

NameTypeDescription
messageIExternalExternal message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): External

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

External

External


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for External

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageExternalExternal
options?IConversionOptionsConversion options

Returns

Object

Plain object