Class: EndpointSpec
Represents an EndpointSpec.
Properties
description
• Optional description: null | $Properties
The markdown description of the endpoint - optional. temporal:versioning:min_version=v0.4.0
descriptionDeprecated
• descriptionDeprecated: string
Deprecated: Not supported after v0.4.0 api version. Use description instead. temporal:versioning:max_version=v0.4.0
name
• name: string
The name of the endpoint. Must be unique within an account.
The name must match ^[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9]$.
This field is mutable.
policySpecs
• policySpecs: $Properties[]
The set of policies (e.g. authorization) for the endpoint. Each request's caller must match with at least one of the specs to be accepted by the endpoint. This field is mutable.
targetSpec
• Optional targetSpec: null | $Properties
Indicates where the endpoint should forward received nexus requests to.
Methods
toJSON
▸ toJSON(): Object
Converts this EndpointSpec to JSON.
Returns
Object
JSON object
create
▸ create(properties?): EndpointSpec & $Shape
Creates a new EndpointSpec instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
EndpointSpec instance
▸ create(properties?): EndpointSpec
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): EndpointSpec & $Shape
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 & $Shape
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.cloud.nexus.v1.EndpointSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | 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.cloud.nexus.v1.EndpointSpec.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | 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
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