Class: Endpoint
An endpoint that receives and then routes Nexus requests
Implements
Constructors
constructor
• new Endpoint(properties?): Endpoint
Constructs a new Endpoint.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IEndpoint | Properties to set |
Returns
Properties
asyncOperationId
• asyncOperationId: string
The id of any ongoing async operation that is creating, updating, or deleting the endpoint, if any.
Implementation of
createdTime
• Optional createdTime: null | ITimestamp
The date and time when the endpoint was created.
Implementation of
id
• id: string
The id of the endpoint. This is generated by the server and is immutable.
Implementation of
lastModifiedTime
• Optional lastModifiedTime: null | ITimestamp
The date and time when the endpoint was last modified.
Implementation of
resourceVersion
• resourceVersion: string
The current version of the endpoint specification. The next update operation must include this version.
Implementation of
spec
• Optional spec: null | IEndpointSpec
The endpoint specification.
Implementation of
state
• state: ResourceState
The current state of the endpoint. For any failed state, reach out to Temporal Cloud support for remediation.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Endpoint to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Endpoint
Creates a new Endpoint instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IEndpoint | Properties to set |
Returns
Endpoint instance
decode
▸ decode(reader, length?): Endpoint
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
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.cloud.nexus.v1.Endpoint.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IEndpoint | 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.cloud.nexus.v1.Endpoint.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IEndpoint | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Endpoint
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 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