Struct Endpoint

pub struct Endpoint {
    pub max_protocol_version: i64,
    pub min_protocol_version: i64,
    pub protocol_mode: Option<ProtocolMode>,
    pub services: Vec<Service>,
}

Restate endpoint manifest v3

JSON schema

{
 "$id": "https://restate.dev/endpoint.manifest.json",
 "title": "Endpoint",
 "description": "Restate endpoint manifest v3",
 "type": "object",
 "required": [
   "maxProtocolVersion",
   "minProtocolVersion",
   "services"
 ],
 "properties": {
   "maxProtocolVersion": {
     "description": "Maximum supported protocol version",
     "type": "integer",
     "maximum": 2147483647.0,
     "minimum": 1.0
   },
   "minProtocolVersion": {
     "description": "Minimum supported protocol version",
     "type": "integer",
     "maximum": 2147483647.0,
     "minimum": 1.0
   },
   "protocolMode": {
     "title": "ProtocolMode",
     "enum": [
       "BIDI_STREAM",
       "REQUEST_RESPONSE"
     ]
   },
   "services": {
     "type": "array",
     "items": {
       "title": "Service",
       "type": "object",
       "required": [
         "handlers",
         "name",
         "ty"
       ],
       "properties": {
         "abortTimeout": {
           "description": "Abort timeout duration, expressed in milliseconds.",
           "type": "integer",
           "minimum": 0.0
         },
         "documentation": {
           "description": "Documentation for this service definition. No format is enforced, but generally Markdown is assumed.",
           "type": "string"
         },
         "enableLazyState": {
           "description": "If true, lazy state is enabled.",
           "type": "boolean"
         },
         "handlers": {
           "type": "array",
           "items": {
             "title": "Handler",
             "type": "object",
             "required": [
               "name"
             ],
             "properties": {
               "abortTimeout": {
                 "description": "Abort timeout duration, expressed in milliseconds.",
                 "type": "integer",
                 "minimum": 0.0
               },
               "documentation": {
                 "description": "Documentation for this handler definition. No format is enforced, but generally Markdown is assumed.",
                 "type": "string"
               },
               "enableLazyState": {
                 "description": "If true, lazy state is enabled.",
                 "type": "boolean"
               },
               "idempotencyRetention": {
                 "description": "Idempotency retention duration, expressed in milliseconds. This is NOT VALID when HandlerType == WORKFLOW",
                 "type": "integer",
                 "minimum": 0.0
               },
               "inactivityTimeout": {
                 "description": "Inactivity timeout duration, expressed in milliseconds.",
                 "type": "integer",
                 "minimum": 0.0
               },
               "ingressPrivate": {
                 "description": "If true, the service cannot be invoked from the HTTP nor Kafka ingress.",
                 "type": "boolean"
               },
               "input": {
                 "title": "InputPayload",
                 "description": "Description of an input payload. This will be used by Restate to validate incoming requests.",
                 "type": "object",
                 "properties": {
                   "contentType": {
                     "description": "Content type of the input. It can accept wildcards, in the same format as the 'Accept' header. When this field is unset, it implies emptiness, meaning no content-type/body is expected.",
                     "type": "string"
                   },
                   "jsonSchema": {},
                   "required": {
                     "description": "If true, a body MUST be sent with a content-type, even if the body length is zero.",
                     "type": "boolean"
                   }
                 },
                 "additionalProperties": false
               },
               "journalRetention": {
                 "description": "Journal retention duration, expressed in milliseconds.",
                 "type": "integer",
                 "minimum": 0.0
               },
               "metadata": {
                 "description": "Custom metadata of this handler definition. This metadata is shown on the Admin API when querying the service/handler definition.",
                 "type": "object",
                 "additionalProperties": {
                   "type": "string"
                 }
               },
               "name": {
                 "type": "string",
                 "pattern": "^([a-zA-Z]|_[a-zA-Z0-9])[a-zA-Z0-9_]*$"
               },
               "output": {
                 "title": "OutputPayload",
                 "description": "Description of an output payload.",
                 "type": "object",
                 "properties": {
                   "contentType": {
                     "description": "Content type set on output. This will be used by Restate to set the output content type at the ingress.",
                     "type": "string"
                   },
                   "jsonSchema": {},
                   "setContentTypeIfEmpty": {
                     "description": "If true, the specified content-type is set even if the output is empty.",
                     "type": "boolean"
                   }
                 },
                 "additionalProperties": false
               },
               "ty": {
                 "title": "HandlerType",
                 "description": "If unspecified, defaults to EXCLUSIVE for Virtual Object or WORKFLOW for Workflows. This should be unset for Services.",
                 "enum": [
                   "WORKFLOW",
                   "EXCLUSIVE",
                   "SHARED"
                 ]
               },
               "workflowCompletionRetention": {
                 "description": "Workflow completion retention duration, expressed in milliseconds. This is valid ONLY when HandlerType == WORKFLOW",
                 "type": "integer",
                 "minimum": 0.0
               }
             },
             "additionalProperties": false
           }
         },
         "idempotencyRetention": {
           "description": "Idempotency retention duration, expressed in milliseconds. When ServiceType == WORKFLOW, this option will be applied only to the shared handlers. See workflowCompletionRetention for more details.",
           "type": "integer",
           "minimum": 0.0
         },
         "inactivityTimeout": {
           "description": "Inactivity timeout duration, expressed in milliseconds.",
           "type": "integer",
           "minimum": 0.0
         },
         "ingressPrivate": {
           "description": "If true, the service cannot be invoked from the HTTP nor Kafka ingress.",
           "type": "boolean"
         },
         "journalRetention": {
           "description": "Journal retention duration, expressed in milliseconds.",
           "type": "integer",
           "minimum": 0.0
         },
         "metadata": {
           "description": "Custom metadata of this service definition. This metadata is shown on the Admin API when querying the service definition.",
           "type": "object",
           "additionalProperties": {
             "type": "string"
           }
         },
         "name": {
           "type": "string",
           "pattern": "^([a-zA-Z]|_[a-zA-Z0-9])[a-zA-Z0-9._-]*$"
         },
         "ty": {
           "title": "ServiceType",
           "enum": [
             "VIRTUAL_OBJECT",
             "SERVICE",
             "WORKFLOW"
           ]
         }
       },
       "additionalProperties": false
     }
   }
 },
 "additionalProperties": false
}

Fields

max_protocol_version: i64

Maximum supported protocol version

min_protocol_version: i64

Minimum supported protocol version

protocol_mode: Option<ProtocolMode>

services: Vec<Service>

Trait Implementations

impl Clone for Endpoint

fn clone(&self) -> Endpoint

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Endpoint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Endpoint

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Endpoint> for Endpoint

fn from(value: &Endpoint) -> Self

Converts to this type from the input type.

impl Serialize for Endpoint

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.