package jina

Get desktop application:
View/edit binary Protocol Buffers messages

* jina gRPC service for DataRequests.

• rpc process_data (DataRequestListProto, DataRequestProto)

  jina.proto:149

  Used for passing DataRequests to the Executors

  message DataRequestListProto

  jina.proto:140

  * Represents a list of data requests This should be replaced by streaming

  • repeated DataRequestProto requests = 1

    requests in this list

* jina gRPC service to expose Endpoints from Executors.

• rpc endpoint_discovery (google.protobuf.Empty, EndpointsProto)

  jina.proto:176

  message EndpointsProto

  jina.proto:52

  * Represents the set of Endpoints exposed by an Executor

  • repeated string endpoints = 1

    list of endpoints exposed by an Executor

* jina gRPC service to expose Endpoints from Executors.

• rpc dry_run (google.protobuf.Empty, StatusProto)

  jina.proto:185

* jina gRPC service to expose information about running jina version and environment.

• rpc _status (google.protobuf.Empty, JinaInfoProto)

  jina.proto:193

  message JinaInfoProto

  jina.proto:22

  • map<string, string> jina_info = 1

    WONTFIX: There's a bug in kotlin GRPC that errors when we name something "jina", so I called it jina_info for now

    information about the system running and package version information including jina

  • map<string, string> envs = 2

    the environment variable setting

* jina Gateway gRPC service.

• rpc Call (stream DataRequestProto, stream DataRequestProto)

  jina.proto:168

  Pass in a Request and a filled Request with matches will be returned.

* jina gRPC service for DataRequests. This is used to send requests to Executors when a list of requests is not needed

• rpc process_single_data (DataRequestProto, DataRequestProto)

  jina.proto:159

  Used for passing DataRequests to the Executors

* Represents a DataRequest

Used as request type in: JinaRPC.Call, JinaSingleDataRequestRPC.process_single_data

Used as response type in: JinaDataRequestRPC.process_data, JinaRPC.Call, JinaSingleDataRequestRPC.process_single_data

Used as field type in: DataRequestListProto

• optional HeaderProto header = 1

  header contains meta info defined by the user

• optional google.protobuf.Struct parameters = 2

  extra kwargs that will be used in executor

• repeated RouteProto routes = 3

  status info on every routes

• optional DataRequestProto.DataContentProto data = 4

  container for docs and groundtruths

Used in: DataRequestProto

• oneof documents

  • docarray.DocumentArrayProto docs = 1

    the docs in this request

  • bytes docs_bytes = 2

    the docs in this request as bytes

• optional HeaderProto header = 1

  header contains meta info defined by the user

• optional google.protobuf.Struct parameters = 2

  extra kwargs that will be used in executor

• repeated RouteProto routes = 3

  status info on every routes

* Represents a Header. - The header's content will be defined by the user request. - It will be copied to the envelope.header - In-flow operations will modify the envelope.header - While returning, copy envelope.header back to request.header

Used in: DataRequestProto, DataRequestProtoWoData

• string request_id = 1

  the unique ID of this request. Multiple requests with the same ID will be gathered

• optional StatusProto status = 2

  status info

• optional string exec_endpoint = 3

  the endpoint specified by `@requests(on='/abc')`

• optional string target_executor = 4

  if set, the request is targeted to certain executor, regex strings

• optional uint32 timeout = 5

  epoch time in seconds after which the request should be dropped

* Represents an entity (like an ExecutorRuntime)

• string id = 1

  unique id of the entity, like the name of a pod

• string address = 2

  address of the entity, could be an IP address, domain name etc, does not include port

• uint32 port = 3

  port this entity is listening on

• optional uint32 shard_id = 4

  the id of the shard it belongs to, if it is a shard

* Represents a the route paths of this message as perceived by the Gateway start_time is set when the Gateway sends a message to a Pod end_time is set when the Gateway receives a message from a Pod thus end_time - start_time includes Executor computation, runtime overhead, serialization and network

Used in: DataRequestProto, DataRequestProtoWoData

• string executor = 1

  the name of the BasePod

• optional google.protobuf.Timestamp start_time = 2

  time when the Gateway starts sending to the Pod

• optional google.protobuf.Timestamp end_time = 3

  time when the Gateway received it from the Pod

• optional StatusProto status = 4

  the status of the execution

* Represents a Status

Used as response type in: JinaGatewayDryRunRPC.dry_run

Used as field type in: HeaderProto, RouteProto

• StatusProto.StatusCode code = 1

  status code

• string description = 2

  error description of the very first exception

• optional StatusProto.ExceptionProto exception = 3

  the details of the error

Used in: StatusProto

• string name = 1

  the class name of the exception

• repeated string args = 2

  the list of arguments given to the exception constructor.

• repeated string stacks = 3

  the exception traceback stacks

• string executor = 4

  the name of the executor bind to that Executor (if applicable)

Used in: StatusProto

• SUCCESS = 0

  success

• ERROR = 1

  error