gRPCOptionsSchema

pydantic model ray.serve.schema.gRPCOptionsSchema

Options to start the gRPC Proxy with.

field enable_reflection: bool = True

Enable the gRPC server reflection protocol on Serve’s gRPC proxy so tools such as grpcurl and grpcui can discover and call the registered gRPC services. Defaults to True.

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.

field request_timeout_s: float | None = None

The timeout for gRPC requests. Defaults to no timeout.