Class: Endpoint
A cluster-global binding from an endpoint ID to a target for dispatching incoming Nexus requests.
Properties
createdTime
• Optional createdTime: null | $Properties
The date and time when the endpoint was created. (-- api-linter: core::0142::time-field-names=disabled aip.dev/not-precedent: Not following linter rules. --)
id
• id: string
Unique server-generated endpoint ID.
lastModifiedTime
• Optional lastModifiedTime: null | $Properties
The date and time when the endpoint was last modified. Will not be set if the endpoint has never been modified. (-- api-linter: core::0142::time-field-names=disabled aip.dev/not-precedent: Not following linter rules. --)
spec
• Optional spec: null | $Properties
Spec for the endpoint.
urlPrefix
• urlPrefix: string
Server exposed URL prefix for invocation of operations on this endpoint. This doesn't include the protocol, hostname or port as the server does not know how it should be accessed publicly. The URL is stable in the face of endpoint renames.
version
• version: Long
Data version for this endpoint, incremented for every update issued via the UpdateNexusEndpoint API.
Methods
toJSON
▸ toJSON(): Object
Converts this Endpoint to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Endpoint & $Shape
Creates a new Endpoint instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
Endpoint instance
▸ create(properties?): Endpoint
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): Endpoint & $Shape
Decodes an Endpoint 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
Endpoint
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Endpoint & $Shape
Decodes an Endpoint message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Endpoint
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 Endpoint message. Does not implicitly temporal.api.nexus.v1.Endpoint.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Endpoint message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Endpoint message, length delimited. Does not implicitly temporal.api.nexus.v1.Endpoint.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Endpoint message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Endpoint
Creates an Endpoint message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Endpoint
toObject
▸ toObject(message, options?): Object
Creates a plain object from an Endpoint message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Endpoint | Endpoint |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object