ray.serve.schema.ServeDeploySchema#

class ray.serve.schema.ServeDeploySchema(*, proxy_location: ProxyLocation = ProxyLocation.EveryNode, http_options: HTTPOptionsSchema = HTTPOptionsSchema(host='0.0.0.0', port=8000, root_path='', request_timeout_s=None, keep_alive_timeout_s=5), grpc_options: gRPCOptionsSchema = gRPCOptionsSchema(port=9000, grpc_servicer_functions=[]), logging_config: LoggingConfig = None, applications: List[ServeApplicationSchema], target_capacity: ConstrainedFloatValue | None = None)[source]#

Bases: BaseModel

Multi-application config for deploying a list of Serve applications to the Ray cluster.

This is the request JSON schema for the v2 REST API PUT "/api/serve/applications/".

NOTE: This config allows extra parameters to make it forward-compatible (ie: older versions of Serve are able to accept configs from a newer versions, simply ignoring new parameters)

Methods

`__init__`	Create a new model by parsing and validating input data from keyword arguments.
`construct`	Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.
`copy`	Duplicate a model, optionally choose which fields to include, exclude and change.
`dict`	Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
`get_empty_schema_dict`	Returns an empty deploy schema dictionary.
`json`	Generate a JSON representation of the model, `include` and `exclude` arguments as per `dict()`.
`update_forward_refs`	Try to update ForwardRefs on fields based on this Model, globalns and localns.

Attributes

`proxy_location`
`http_options`
`grpc_options`
`logging_config`
`applications`
`target_capacity`