Skip to main content

Class: EndpointSpec

nexus.v1.EndpointSpec

Contains mutable fields for an Endpoint.

Implements

Constructors

constructor

new EndpointSpec(properties?): EndpointSpec

Constructs a new EndpointSpec.

Parameters

NameTypeDescription
properties?IEndpointSpecProperties to set

Returns

EndpointSpec

Properties

metadata

Optional metadata: null | IUserMetadata

EndpointSpec metadata.

Implementation of

IEndpointSpec.metadata


name

name: string

Endpoint name, unique for this cluster. Must match [a-zA-Z_][a-zA-Z0-9_]*. Renaming an endpoint breaks all workflow callers that reference this endpoint, causing operations to fail.

Implementation of

IEndpointSpec.name


target

Optional target: null | IEndpointTarget

Target to route requests to.

Implementation of

IEndpointSpec.target

Methods

toJSON

toJSON(): Object

Converts this EndpointSpec to JSON.

Returns

Object

JSON object


create

create(properties?): EndpointSpec

Creates a new EndpointSpec instance using the specified properties.

Parameters

NameTypeDescription
properties?IEndpointSpecProperties to set

Returns

EndpointSpec

EndpointSpec instance


decode

decode(reader, length?): EndpointSpec

Decodes an EndpointSpec message from the specified reader or buffer.

Parameters

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

Returns

EndpointSpec

EndpointSpec

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): EndpointSpec

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

EndpointSpec

EndpointSpec

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): EndpointSpec

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

EndpointSpec

EndpointSpec


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for EndpointSpec

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 EndpointSpec message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageEndpointSpecEndpointSpec
options?IConversionOptionsConversion options

Returns

Object

Plain object