ray.serve.schema.gRPCOptionsSchema#

pydantic model ray.serve.schema.gRPCOptionsSchema[source]#

Options to start the gRPC Proxy with.

PublicAPI (alpha): This API is in alpha and may change before becoming stable.

Show JSON schema

{
   "title": "gRPCOptionsSchema",
   "description": "Options to start the gRPC Proxy with.\n\n**PublicAPI (alpha):** This API is in alpha and may change before becoming stable.",
   "type": "object",
   "properties": {
      "port": {
         "title": "Port",
         "description": "Port for gRPC server. Defaults to 9000. Cannot be updated once Serve has started running. Serve must be shut down and restarted with the new port instead.",
         "default": 9000,
         "type": "integer"
      },
      "grpc_servicer_functions": {
         "title": "Grpc Servicer Functions",
         "description": "List of import paths for gRPC `add_servicer_to_server` functions to add to Serve's gRPC proxy. Default to empty list, which means no gRPC methods will be added and no gRPC server will be started. The servicer functions need to be importable from the context of where Serve is running.",
         "default": [],
         "type": "array",
         "items": {
            "type": "string"
         }
      }
   }
}

Fields:

grpc_servicer_functions (List[str])
port (int)

field grpc_servicer_functions: List[str] = []#: List of import paths for gRPC add_servicer_to_server functions to add to Serve’s gRPC proxy. Default to empty list, which means no gRPC methods will be added and no gRPC server will be started. The servicer functions need to be importable from the context of where Serve is running.

field port: int = 9000#: Port for gRPC server. Defaults to 9000. Cannot be updated once Serve has started running. Serve must be shut down and restarted with the new port instead.