Class: EndpointSpec
Contains mutable fields for an Endpoint.
Implements
Constructors
constructor
• new EndpointSpec(properties?): EndpointSpec
Constructs a new EndpointSpec.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IEndpointSpec | Properties to set |
Returns
Properties
description
• Optional description: null | IPayload
Markdown description serialized as a single JSON string. If the Payload is encrypted, the UI and CLI may decrypt with the configured codec server endpoint. By default, the server enforces a limit of 20,000 bytes for this entire payload.
Implementation of
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
target
• Optional target: null | IEndpointTarget
Target to route requests to.
Implementation of
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
| Name | Type | Description |
|---|---|---|
properties? | IEndpointSpec | Properties to set |
Returns
EndpointSpec instance
decode
▸ decode(reader, length?): EndpointSpec
Decodes an EndpointSpec message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
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
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
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
| Name | Type | Description |
|---|---|---|
message | IEndpointSpec | EndpointSpec message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
message | IEndpointSpec | EndpointSpec message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
EndpointSpec
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for EndpointSpec
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your 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
| Name | Type | Description |
|---|---|---|
message | EndpointSpec | EndpointSpec |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object