jina.serve.runtimes.gateway.http package

Submodules

• jina.serve.runtimes.gateway.http.app module
  • get_fastapi_app()
• jina.serve.runtimes.gateway.http.models module
  • CustomConfig
    • CustomConfig.use_enum_values
    • CustomConfig.allow_population_by_field_name
    • CustomConfig.alias_generator
    • CustomConfig.allow_inf_nan
    • CustomConfig.allow_mutation
    • CustomConfig.anystr_lower
    • CustomConfig.anystr_strip_whitespace
    • CustomConfig.anystr_upper
    • CustomConfig.arbitrary_types_allowed
    • CustomConfig.copy_on_model_validation
    • CustomConfig.error_msg_templates
    • CustomConfig.extra
    • CustomConfig.fields
    • CustomConfig.frozen
    • CustomConfig.get_field_info()
    • CustomConfig.getter_dict
    • CustomConfig.json_dumps()
    • CustomConfig.json_encoders
    • CustomConfig.json_loads()
    • CustomConfig.keep_untouched
    • CustomConfig.max_anystr_length
    • CustomConfig.min_anystr_length
    • CustomConfig.orm_mode
    • CustomConfig.post_init_call
    • CustomConfig.prepare_field()
    • CustomConfig.schema_extra
    • CustomConfig.smart_union
    • CustomConfig.title
    • CustomConfig.underscore_attrs_are_private
    • CustomConfig.validate_all
    • CustomConfig.validate_assignment
  • protobuf_to_pydantic_model()
  • JinaHealthModel
    • JinaHealthModel.Config
    • JinaHealthModel.construct()
    • JinaHealthModel.copy()
    • JinaHealthModel.dict()
    • JinaHealthModel.from_orm()
    • JinaHealthModel.json()
    • JinaHealthModel.parse_file()
    • JinaHealthModel.parse_obj()
    • JinaHealthModel.parse_raw()
    • JinaHealthModel.schema()
    • JinaHealthModel.schema_json()
    • JinaHealthModel.update_forward_refs()
    • JinaHealthModel.validate()
  • JinaInfoModel
    • JinaInfoModel.jina
    • JinaInfoModel.envs
    • JinaInfoModel.Config
      • JinaInfoModel.Config.alias_generator()
      • JinaInfoModel.Config.allow_population_by_field_name
    • JinaInfoModel.construct()
    • JinaInfoModel.copy()
    • JinaInfoModel.dict()
    • JinaInfoModel.from_orm()
    • JinaInfoModel.json()
    • JinaInfoModel.parse_file()
    • JinaInfoModel.parse_obj()
    • JinaInfoModel.parse_raw()
    • JinaInfoModel.schema()
    • JinaInfoModel.schema_json()
    • JinaInfoModel.update_forward_refs()
    • JinaInfoModel.validate()
  • JinaRequestModel
    • JinaRequestModel.data
    • JinaRequestModel.target_executor
    • JinaRequestModel.parameters
    • JinaRequestModel.Config
      • JinaRequestModel.Config.alias_generator()
      • JinaRequestModel.Config.allow_population_by_field_name
    • JinaRequestModel.construct()
    • JinaRequestModel.copy()
    • JinaRequestModel.dict()
    • JinaRequestModel.from_orm()
    • JinaRequestModel.json()
    • JinaRequestModel.parse_file()
    • JinaRequestModel.parse_obj()
    • JinaRequestModel.parse_raw()
    • JinaRequestModel.schema()
    • JinaRequestModel.schema_json()
    • JinaRequestModel.update_forward_refs()
    • JinaRequestModel.validate()
  • JinaResponseModel
    • JinaResponseModel.header
    • JinaResponseModel.parameters
    • JinaResponseModel.routes
    • JinaResponseModel.data
    • JinaResponseModel.Config
      • JinaResponseModel.Config.alias_generator()
      • JinaResponseModel.Config.allow_population_by_field_name
    • JinaResponseModel.construct()
    • JinaResponseModel.copy()
    • JinaResponseModel.dict()
    • JinaResponseModel.from_orm()
    • JinaResponseModel.json()
    • JinaResponseModel.parse_file()
    • JinaResponseModel.parse_obj()
    • JinaResponseModel.parse_raw()
    • JinaResponseModel.schema()
    • JinaResponseModel.schema_json()
    • JinaResponseModel.update_forward_refs()
    • JinaResponseModel.validate()
  • JinaEndpointRequestModel
    • JinaEndpointRequestModel.exec_endpoint
    • JinaEndpointRequestModel.Config
      • JinaEndpointRequestModel.Config.alias_generator()
      • JinaEndpointRequestModel.Config.allow_population_by_field_name
    • JinaEndpointRequestModel.construct()
    • JinaEndpointRequestModel.copy()
    • JinaEndpointRequestModel.dict()
    • JinaEndpointRequestModel.from_orm()
    • JinaEndpointRequestModel.json()
    • JinaEndpointRequestModel.parse_file()
    • JinaEndpointRequestModel.parse_obj()
    • JinaEndpointRequestModel.parse_raw()
    • JinaEndpointRequestModel.schema()
    • JinaEndpointRequestModel.schema_json()
    • JinaEndpointRequestModel.update_forward_refs()
    • JinaEndpointRequestModel.validate()
    • JinaEndpointRequestModel.data
    • JinaEndpointRequestModel.target_executor
    • JinaEndpointRequestModel.parameters

Module contents

class jina.serve.runtimes.gateway.http.HTTPGatewayRuntime(args, cancel_event=None, **kwargs)

Bases: GatewayRuntime

Runtime for HTTP interface.

async async_setup()

The async method setup the runtime.

Setup the uvicorn server.

async async_run_forever()

Running method of the server.

async async_teardown()

Shutdown the server.

async async_cancel()

Stop the server.

static activate(**kwargs)

Activate the runtime, does not apply to these runtimes

Parameters:

kwargs – extra keyword arguments

static is_ready(ctrl_address, **kwargs)

Check if status is ready.

Parameters:

• ctrl_address (str) – the address where the control request needs to be sent

• kwargs – extra keyword arguments

Return type:

bool

Returns:

True if status is ready else False.

run_forever()

Running method to block the main thread.

Run the event loop until a Future is done.

teardown()

Call async_teardown() and stop and close the event loop.

static wait_for_ready_or_shutdown(timeout, ready_or_shutdown_event, ctrl_address, **kwargs)

Check if the runtime has successfully started

Parameters:

• timeout (Optional[float]) – The time to wait before readiness or failure is determined

• ctrl_address (str) – the address where the control message needs to be sent

• ready_or_shutdown_event (Union[Event, Event]) – the multiprocessing event to detect if the process failed or is ready

• kwargs – extra keyword arguments

Returns:

True if is ready or it needs to be shutdown