Documentation ¶
Index ¶
- Variables
- func RegisterJinaDataRequestRPCServer(s grpc.ServiceRegistrar, srv JinaDataRequestRPCServer)
- func RegisterJinaDiscoverEndpointsRPCServer(s grpc.ServiceRegistrar, srv JinaDiscoverEndpointsRPCServer)
- func RegisterJinaGatewayDryRunRPCServer(s grpc.ServiceRegistrar, srv JinaGatewayDryRunRPCServer)
- func RegisterJinaInfoRPCServer(s grpc.ServiceRegistrar, srv JinaInfoRPCServer)
- func RegisterJinaRPCServer(s grpc.ServiceRegistrar, srv JinaRPCServer)
- func RegisterJinaSingleDataRequestRPCServer(s grpc.ServiceRegistrar, srv JinaSingleDataRequestRPCServer)
- type DataRequestListProto
- func (*DataRequestListProto) Descriptor() ([]byte, []int)deprecated
- func (x *DataRequestListProto) GetRequests() []*DataRequestProto
- func (*DataRequestListProto) ProtoMessage()
- func (x *DataRequestListProto) ProtoReflect() protoreflect.Message
- func (x *DataRequestListProto) Reset()
- func (x *DataRequestListProto) String() string
- type DataRequestProto
- func (*DataRequestProto) Descriptor() ([]byte, []int)deprecated
- func (x *DataRequestProto) GetData() *DataRequestProto_DataContentProto
- func (x *DataRequestProto) GetHeader() *HeaderProto
- func (x *DataRequestProto) GetParameters() *structpb.Struct
- func (x *DataRequestProto) GetRoutes() []*RouteProto
- func (x *DataRequestProto) MarshalJSON() ([]byte, error)
- func (*DataRequestProto) ProtoMessage()
- func (x *DataRequestProto) ProtoReflect() protoreflect.Message
- func (x *DataRequestProto) Reset()
- func (x *DataRequestProto) String() string
- func (x *DataRequestProto) UnmarshalJSON(data []byte) error
- type DataRequestProtoWoData
- func (*DataRequestProtoWoData) Descriptor() ([]byte, []int)deprecated
- func (x *DataRequestProtoWoData) GetHeader() *HeaderProto
- func (x *DataRequestProtoWoData) GetParameters() *structpb.Struct
- func (x *DataRequestProtoWoData) GetRoutes() []*RouteProto
- func (*DataRequestProtoWoData) ProtoMessage()
- func (x *DataRequestProtoWoData) ProtoReflect() protoreflect.Message
- func (x *DataRequestProtoWoData) Reset()
- func (x *DataRequestProtoWoData) String() string
- type DataRequestProto_DataContentProto
- func (*DataRequestProto_DataContentProto) Descriptor() ([]byte, []int)deprecated
- func (x *DataRequestProto_DataContentProto) GetDocs() *docarray.DocumentArrayProto
- func (x *DataRequestProto_DataContentProto) GetDocsBytes() []byte
- func (m *DataRequestProto_DataContentProto) GetDocuments() isDataRequestProto_DataContentProto_Documents
- func (*DataRequestProto_DataContentProto) ProtoMessage()
- func (x *DataRequestProto_DataContentProto) ProtoReflect() protoreflect.Message
- func (x *DataRequestProto_DataContentProto) Reset()
- func (x *DataRequestProto_DataContentProto) String() string
- type DataRequestProto_DataContentProto_Docs
- type DataRequestProto_DataContentProto_DocsBytes
- type EndpointsProto
- type HeaderProto
- func (*HeaderProto) Descriptor() ([]byte, []int)deprecated
- func (x *HeaderProto) GetExecEndpoint() string
- func (x *HeaderProto) GetRequestId() string
- func (x *HeaderProto) GetStatus() *StatusProto
- func (x *HeaderProto) GetTargetExecutor() string
- func (x *HeaderProto) GetTimeout() uint32
- func (*HeaderProto) ProtoMessage()
- func (x *HeaderProto) ProtoReflect() protoreflect.Message
- func (x *HeaderProto) Reset()
- func (x *HeaderProto) String() string
- type JinaDataRequestRPCClient
- type JinaDataRequestRPCServer
- type JinaDiscoverEndpointsRPCClient
- type JinaDiscoverEndpointsRPCServer
- type JinaGatewayDryRunRPCClient
- type JinaGatewayDryRunRPCServer
- type JinaInfoProto
- func (*JinaInfoProto) Descriptor() ([]byte, []int)deprecated
- func (x *JinaInfoProto) GetEnvs() map[string]string
- func (x *JinaInfoProto) GetJina() map[string]string
- func (*JinaInfoProto) ProtoMessage()
- func (x *JinaInfoProto) ProtoReflect() protoreflect.Message
- func (x *JinaInfoProto) Reset()
- func (x *JinaInfoProto) String() string
- type JinaInfoRPCClient
- type JinaInfoRPCServer
- type JinaRPCClient
- type JinaRPCServer
- type JinaRPC_CallClient
- type JinaRPC_CallServer
- type JinaSingleDataRequestRPCClient
- type JinaSingleDataRequestRPCServer
- type RelatedEntity
- func (*RelatedEntity) Descriptor() ([]byte, []int)deprecated
- func (x *RelatedEntity) GetAddress() string
- func (x *RelatedEntity) GetId() string
- func (x *RelatedEntity) GetPort() uint32
- func (x *RelatedEntity) GetShardId() uint32
- func (*RelatedEntity) ProtoMessage()
- func (x *RelatedEntity) ProtoReflect() protoreflect.Message
- func (x *RelatedEntity) Reset()
- func (x *RelatedEntity) String() string
- type RouteProto
- func (*RouteProto) Descriptor() ([]byte, []int)deprecated
- func (x *RouteProto) GetEndTime() *timestamppb.Timestamp
- func (x *RouteProto) GetExecutor() string
- func (x *RouteProto) GetStartTime() *timestamppb.Timestamp
- func (x *RouteProto) GetStatus() *StatusProto
- func (x *RouteProto) MarshalJSON() ([]byte, error)
- func (*RouteProto) ProtoMessage()
- func (x *RouteProto) ProtoReflect() protoreflect.Message
- func (x *RouteProto) Reset()
- func (x *RouteProto) String() string
- func (x *RouteProto) UnmarshalJSON(data []byte) error
- type StatusProto
- func (*StatusProto) Descriptor() ([]byte, []int)deprecated
- func (x *StatusProto) GetCode() StatusProto_StatusCode
- func (x *StatusProto) GetDescription() string
- func (x *StatusProto) GetException() *StatusProto_ExceptionProto
- func (*StatusProto) ProtoMessage()
- func (x *StatusProto) ProtoReflect() protoreflect.Message
- func (x *StatusProto) Reset()
- func (x *StatusProto) String() string
- type StatusProto_ExceptionProto
- func (*StatusProto_ExceptionProto) Descriptor() ([]byte, []int)deprecated
- func (x *StatusProto_ExceptionProto) GetArgs() []string
- func (x *StatusProto_ExceptionProto) GetExecutor() string
- func (x *StatusProto_ExceptionProto) GetName() string
- func (x *StatusProto_ExceptionProto) GetStacks() []string
- func (*StatusProto_ExceptionProto) ProtoMessage()
- func (x *StatusProto_ExceptionProto) ProtoReflect() protoreflect.Message
- func (x *StatusProto_ExceptionProto) Reset()
- func (x *StatusProto_ExceptionProto) String() string
- type StatusProto_StatusCode
- func (StatusProto_StatusCode) Descriptor() protoreflect.EnumDescriptor
- func (x StatusProto_StatusCode) Enum() *StatusProto_StatusCode
- func (StatusProto_StatusCode) EnumDescriptor() ([]byte, []int)deprecated
- func (x StatusProto_StatusCode) Number() protoreflect.EnumNumber
- func (x StatusProto_StatusCode) String() string
- func (StatusProto_StatusCode) Type() protoreflect.EnumType
- type UnimplementedJinaDataRequestRPCServer
- type UnimplementedJinaDiscoverEndpointsRPCServer
- type UnimplementedJinaGatewayDryRunRPCServer
- type UnimplementedJinaInfoRPCServer
- type UnimplementedJinaRPCServer
- type UnimplementedJinaSingleDataRequestRPCServer
- type UnsafeJinaDataRequestRPCServer
- type UnsafeJinaDiscoverEndpointsRPCServer
- type UnsafeJinaGatewayDryRunRPCServer
- type UnsafeJinaInfoRPCServer
- type UnsafeJinaRPCServer
- type UnsafeJinaSingleDataRequestRPCServer
Constants ¶
This section is empty.
Variables ¶
var ( StatusProto_StatusCode_name = map[int32]string{ 0: "SUCCESS", 1: "ERROR", } StatusProto_StatusCode_value = map[string]int32{ "SUCCESS": 0, "ERROR": 1, } )
Enum value maps for StatusProto_StatusCode.
var File_jina_proto protoreflect.FileDescriptor
var JinaDataRequestRPC_ServiceDesc = grpc.ServiceDesc{ ServiceName: "jina.JinaDataRequestRPC", HandlerType: (*JinaDataRequestRPCServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "process_data", Handler: _JinaDataRequestRPC_ProcessData_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "jina.proto", }
JinaDataRequestRPC_ServiceDesc is the grpc.ServiceDesc for JinaDataRequestRPC service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var JinaDiscoverEndpointsRPC_ServiceDesc = grpc.ServiceDesc{ ServiceName: "jina.JinaDiscoverEndpointsRPC", HandlerType: (*JinaDiscoverEndpointsRPCServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "endpoint_discovery", Handler: _JinaDiscoverEndpointsRPC_EndpointDiscovery_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "jina.proto", }
JinaDiscoverEndpointsRPC_ServiceDesc is the grpc.ServiceDesc for JinaDiscoverEndpointsRPC service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var JinaGatewayDryRunRPC_ServiceDesc = grpc.ServiceDesc{ ServiceName: "jina.JinaGatewayDryRunRPC", HandlerType: (*JinaGatewayDryRunRPCServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "dry_run", Handler: _JinaGatewayDryRunRPC_DryRun_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "jina.proto", }
JinaGatewayDryRunRPC_ServiceDesc is the grpc.ServiceDesc for JinaGatewayDryRunRPC service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var JinaInfoRPC_ServiceDesc = grpc.ServiceDesc{ ServiceName: "jina.JinaInfoRPC", HandlerType: (*JinaInfoRPCServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "_status", Handler: _JinaInfoRPC_XStatus_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "jina.proto", }
JinaInfoRPC_ServiceDesc is the grpc.ServiceDesc for JinaInfoRPC service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var JinaRPC_ServiceDesc = grpc.ServiceDesc{ ServiceName: "jina.JinaRPC", HandlerType: (*JinaRPCServer)(nil), Methods: []grpc.MethodDesc{}, Streams: []grpc.StreamDesc{ { StreamName: "Call", Handler: _JinaRPC_Call_Handler, ServerStreams: true, ClientStreams: true, }, }, Metadata: "jina.proto", }
JinaRPC_ServiceDesc is the grpc.ServiceDesc for JinaRPC service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var JinaSingleDataRequestRPC_ServiceDesc = grpc.ServiceDesc{ ServiceName: "jina.JinaSingleDataRequestRPC", HandlerType: (*JinaSingleDataRequestRPCServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "process_single_data", Handler: _JinaSingleDataRequestRPC_ProcessSingleData_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "jina.proto", }
JinaSingleDataRequestRPC_ServiceDesc is the grpc.ServiceDesc for JinaSingleDataRequestRPC service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterJinaDataRequestRPCServer ¶
func RegisterJinaDataRequestRPCServer(s grpc.ServiceRegistrar, srv JinaDataRequestRPCServer)
func RegisterJinaDiscoverEndpointsRPCServer ¶
func RegisterJinaDiscoverEndpointsRPCServer(s grpc.ServiceRegistrar, srv JinaDiscoverEndpointsRPCServer)
func RegisterJinaGatewayDryRunRPCServer ¶
func RegisterJinaGatewayDryRunRPCServer(s grpc.ServiceRegistrar, srv JinaGatewayDryRunRPCServer)
func RegisterJinaInfoRPCServer ¶
func RegisterJinaInfoRPCServer(s grpc.ServiceRegistrar, srv JinaInfoRPCServer)
func RegisterJinaRPCServer ¶
func RegisterJinaRPCServer(s grpc.ServiceRegistrar, srv JinaRPCServer)
func RegisterJinaSingleDataRequestRPCServer ¶
func RegisterJinaSingleDataRequestRPCServer(s grpc.ServiceRegistrar, srv JinaSingleDataRequestRPCServer)
Types ¶
type DataRequestListProto ¶
type DataRequestListProto struct { Requests []*DataRequestProto `protobuf:"bytes,1,rep,name=requests,proto3" json:"requests,omitempty"` // requests in this list // contains filtered or unexported fields }
* Represents a list of data requests This should be replaced by streaming
func (*DataRequestListProto) Descriptor
deprecated
func (*DataRequestListProto) Descriptor() ([]byte, []int)
Deprecated: Use DataRequestListProto.ProtoReflect.Descriptor instead.
func (*DataRequestListProto) GetRequests ¶
func (x *DataRequestListProto) GetRequests() []*DataRequestProto
func (*DataRequestListProto) ProtoMessage ¶
func (*DataRequestListProto) ProtoMessage()
func (*DataRequestListProto) ProtoReflect ¶
func (x *DataRequestListProto) ProtoReflect() protoreflect.Message
func (*DataRequestListProto) Reset ¶
func (x *DataRequestListProto) Reset()
func (*DataRequestListProto) String ¶
func (x *DataRequestListProto) String() string
type DataRequestProto ¶
type DataRequestProto struct { Header *HeaderProto `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"` // header contains meta info defined by the user Parameters *structpb.Struct `protobuf:"bytes,2,opt,name=parameters,proto3" json:"parameters,omitempty"` // extra kwargs that will be used in executor Routes []*RouteProto `protobuf:"bytes,3,rep,name=routes,proto3" json:"routes,omitempty"` // status info on every routes Data *DataRequestProto_DataContentProto `protobuf:"bytes,4,opt,name=data,proto3" json:"data,omitempty"` // container for docs and groundtruths // contains filtered or unexported fields }
* Represents a DataRequest
func (*DataRequestProto) Descriptor
deprecated
func (*DataRequestProto) Descriptor() ([]byte, []int)
Deprecated: Use DataRequestProto.ProtoReflect.Descriptor instead.
func (*DataRequestProto) GetData ¶
func (x *DataRequestProto) GetData() *DataRequestProto_DataContentProto
func (*DataRequestProto) GetHeader ¶
func (x *DataRequestProto) GetHeader() *HeaderProto
func (*DataRequestProto) GetParameters ¶
func (x *DataRequestProto) GetParameters() *structpb.Struct
func (*DataRequestProto) GetRoutes ¶
func (x *DataRequestProto) GetRoutes() []*RouteProto
func (*DataRequestProto) MarshalJSON ¶
func (x *DataRequestProto) MarshalJSON() ([]byte, error)
Custom JSON marshalling for DataRequestProto
func (*DataRequestProto) ProtoMessage ¶
func (*DataRequestProto) ProtoMessage()
func (*DataRequestProto) ProtoReflect ¶
func (x *DataRequestProto) ProtoReflect() protoreflect.Message
func (*DataRequestProto) Reset ¶
func (x *DataRequestProto) Reset()
func (*DataRequestProto) String ¶
func (x *DataRequestProto) String() string
func (*DataRequestProto) UnmarshalJSON ¶
func (x *DataRequestProto) UnmarshalJSON(data []byte) error
Custom JSON unmarshalling for DataRequestProto
type DataRequestProtoWoData ¶
type DataRequestProtoWoData struct { Header *HeaderProto `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"` // header contains meta info defined by the user Parameters *structpb.Struct `protobuf:"bytes,2,opt,name=parameters,proto3" json:"parameters,omitempty"` // extra kwargs that will be used in executor Routes []*RouteProto `protobuf:"bytes,3,rep,name=routes,proto3" json:"routes,omitempty"` // status info on every routes // contains filtered or unexported fields }
func (*DataRequestProtoWoData) Descriptor
deprecated
func (*DataRequestProtoWoData) Descriptor() ([]byte, []int)
Deprecated: Use DataRequestProtoWoData.ProtoReflect.Descriptor instead.
func (*DataRequestProtoWoData) GetHeader ¶
func (x *DataRequestProtoWoData) GetHeader() *HeaderProto
func (*DataRequestProtoWoData) GetParameters ¶
func (x *DataRequestProtoWoData) GetParameters() *structpb.Struct
func (*DataRequestProtoWoData) GetRoutes ¶
func (x *DataRequestProtoWoData) GetRoutes() []*RouteProto
func (*DataRequestProtoWoData) ProtoMessage ¶
func (*DataRequestProtoWoData) ProtoMessage()
func (*DataRequestProtoWoData) ProtoReflect ¶
func (x *DataRequestProtoWoData) ProtoReflect() protoreflect.Message
func (*DataRequestProtoWoData) Reset ¶
func (x *DataRequestProtoWoData) Reset()
func (*DataRequestProtoWoData) String ¶
func (x *DataRequestProtoWoData) String() string
type DataRequestProto_DataContentProto ¶
type DataRequestProto_DataContentProto struct { // Types that are assignable to Documents: // *DataRequestProto_DataContentProto_Docs // *DataRequestProto_DataContentProto_DocsBytes Documents isDataRequestProto_DataContentProto_Documents `protobuf_oneof:"documents"` // contains filtered or unexported fields }
func (*DataRequestProto_DataContentProto) Descriptor
deprecated
func (*DataRequestProto_DataContentProto) Descriptor() ([]byte, []int)
Deprecated: Use DataRequestProto_DataContentProto.ProtoReflect.Descriptor instead.
func (*DataRequestProto_DataContentProto) GetDocs ¶
func (x *DataRequestProto_DataContentProto) GetDocs() *docarray.DocumentArrayProto
func (*DataRequestProto_DataContentProto) GetDocsBytes ¶
func (x *DataRequestProto_DataContentProto) GetDocsBytes() []byte
func (*DataRequestProto_DataContentProto) GetDocuments ¶
func (m *DataRequestProto_DataContentProto) GetDocuments() isDataRequestProto_DataContentProto_Documents
func (*DataRequestProto_DataContentProto) ProtoMessage ¶
func (*DataRequestProto_DataContentProto) ProtoMessage()
func (*DataRequestProto_DataContentProto) ProtoReflect ¶
func (x *DataRequestProto_DataContentProto) ProtoReflect() protoreflect.Message
func (*DataRequestProto_DataContentProto) Reset ¶
func (x *DataRequestProto_DataContentProto) Reset()
func (*DataRequestProto_DataContentProto) String ¶
func (x *DataRequestProto_DataContentProto) String() string
type DataRequestProto_DataContentProto_Docs ¶
type DataRequestProto_DataContentProto_Docs struct {
Docs *docarray.DocumentArrayProto `protobuf:"bytes,1,opt,name=docs,proto3,oneof"` // the docs in this request
}
type DataRequestProto_DataContentProto_DocsBytes ¶
type DataRequestProto_DataContentProto_DocsBytes struct {
DocsBytes []byte `protobuf:"bytes,2,opt,name=docs_bytes,json=docsBytes,proto3,oneof"` // the docs in this request as bytes
}
type EndpointsProto ¶
type EndpointsProto struct { // list of endpoints exposed by an Executor Endpoints []string `protobuf:"bytes,1,rep,name=endpoints,proto3" json:"endpoints,omitempty"` // contains filtered or unexported fields }
* Represents the set of Endpoints exposed by an Executor
func (*EndpointsProto) Descriptor
deprecated
func (*EndpointsProto) Descriptor() ([]byte, []int)
Deprecated: Use EndpointsProto.ProtoReflect.Descriptor instead.
func (*EndpointsProto) GetEndpoints ¶
func (x *EndpointsProto) GetEndpoints() []string
func (*EndpointsProto) ProtoMessage ¶
func (*EndpointsProto) ProtoMessage()
func (*EndpointsProto) ProtoReflect ¶
func (x *EndpointsProto) ProtoReflect() protoreflect.Message
func (*EndpointsProto) Reset ¶
func (x *EndpointsProto) Reset()
func (*EndpointsProto) String ¶
func (x *EndpointsProto) String() string
type HeaderProto ¶
type HeaderProto struct { RequestId string `protobuf:"bytes,1,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"` // the unique ID of this request. Multiple requests with the same ID will be gathered Status *StatusProto `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"` // status info ExecEndpoint *string `protobuf:"bytes,3,opt,name=exec_endpoint,json=execEndpoint,proto3,oneof" json:"exec_endpoint,omitempty"` // the endpoint specified by `@requests(on='/abc')` TargetExecutor *string `protobuf:"bytes,4,opt,name=target_executor,json=targetExecutor,proto3,oneof" json:"target_executor,omitempty"` // if set, the request is targeted to certain executor, regex strings Timeout *uint32 `protobuf:"varint,5,opt,name=timeout,proto3,oneof" json:"timeout,omitempty"` // epoch time in seconds after which the request should be dropped // contains filtered or unexported fields }
* 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
func (*HeaderProto) Descriptor
deprecated
func (*HeaderProto) Descriptor() ([]byte, []int)
Deprecated: Use HeaderProto.ProtoReflect.Descriptor instead.
func (*HeaderProto) GetExecEndpoint ¶
func (x *HeaderProto) GetExecEndpoint() string
func (*HeaderProto) GetRequestId ¶
func (x *HeaderProto) GetRequestId() string
func (*HeaderProto) GetStatus ¶
func (x *HeaderProto) GetStatus() *StatusProto
func (*HeaderProto) GetTargetExecutor ¶
func (x *HeaderProto) GetTargetExecutor() string
func (*HeaderProto) GetTimeout ¶
func (x *HeaderProto) GetTimeout() uint32
func (*HeaderProto) ProtoMessage ¶
func (*HeaderProto) ProtoMessage()
func (*HeaderProto) ProtoReflect ¶
func (x *HeaderProto) ProtoReflect() protoreflect.Message
func (*HeaderProto) Reset ¶
func (x *HeaderProto) Reset()
func (*HeaderProto) String ¶
func (x *HeaderProto) String() string
type JinaDataRequestRPCClient ¶
type JinaDataRequestRPCClient interface { // Used for passing DataRequests to the Executors ProcessData(ctx context.Context, in *DataRequestListProto, opts ...grpc.CallOption) (*DataRequestProto, error) }
JinaDataRequestRPCClient is the client API for JinaDataRequestRPC service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewJinaDataRequestRPCClient ¶
func NewJinaDataRequestRPCClient(cc grpc.ClientConnInterface) JinaDataRequestRPCClient
type JinaDataRequestRPCServer ¶
type JinaDataRequestRPCServer interface { // Used for passing DataRequests to the Executors ProcessData(context.Context, *DataRequestListProto) (*DataRequestProto, error) // contains filtered or unexported methods }
JinaDataRequestRPCServer is the server API for JinaDataRequestRPC service. All implementations must embed UnimplementedJinaDataRequestRPCServer for forward compatibility
type JinaDiscoverEndpointsRPCClient ¶
type JinaDiscoverEndpointsRPCClient interface {
EndpointDiscovery(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*EndpointsProto, error)
}
JinaDiscoverEndpointsRPCClient is the client API for JinaDiscoverEndpointsRPC service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewJinaDiscoverEndpointsRPCClient ¶
func NewJinaDiscoverEndpointsRPCClient(cc grpc.ClientConnInterface) JinaDiscoverEndpointsRPCClient
type JinaDiscoverEndpointsRPCServer ¶
type JinaDiscoverEndpointsRPCServer interface { EndpointDiscovery(context.Context, *emptypb.Empty) (*EndpointsProto, error) // contains filtered or unexported methods }
JinaDiscoverEndpointsRPCServer is the server API for JinaDiscoverEndpointsRPC service. All implementations must embed UnimplementedJinaDiscoverEndpointsRPCServer for forward compatibility
type JinaGatewayDryRunRPCClient ¶
type JinaGatewayDryRunRPCClient interface {
DryRun(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*StatusProto, error)
}
JinaGatewayDryRunRPCClient is the client API for JinaGatewayDryRunRPC service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewJinaGatewayDryRunRPCClient ¶
func NewJinaGatewayDryRunRPCClient(cc grpc.ClientConnInterface) JinaGatewayDryRunRPCClient
type JinaGatewayDryRunRPCServer ¶
type JinaGatewayDryRunRPCServer interface { DryRun(context.Context, *emptypb.Empty) (*StatusProto, error) // contains filtered or unexported methods }
JinaGatewayDryRunRPCServer is the server API for JinaGatewayDryRunRPC service. All implementations must embed UnimplementedJinaGatewayDryRunRPCServer for forward compatibility
type JinaInfoProto ¶
type JinaInfoProto struct { Jina map[string]string `` // information about the system running and package version information including jina /* 149-byte string literal not displayed */ Envs map[string]string `` // the environment variable setting /* 149-byte string literal not displayed */ // contains filtered or unexported fields }
func (*JinaInfoProto) Descriptor
deprecated
func (*JinaInfoProto) Descriptor() ([]byte, []int)
Deprecated: Use JinaInfoProto.ProtoReflect.Descriptor instead.
func (*JinaInfoProto) GetEnvs ¶
func (x *JinaInfoProto) GetEnvs() map[string]string
func (*JinaInfoProto) GetJina ¶
func (x *JinaInfoProto) GetJina() map[string]string
func (*JinaInfoProto) ProtoMessage ¶
func (*JinaInfoProto) ProtoMessage()
func (*JinaInfoProto) ProtoReflect ¶
func (x *JinaInfoProto) ProtoReflect() protoreflect.Message
func (*JinaInfoProto) Reset ¶
func (x *JinaInfoProto) Reset()
func (*JinaInfoProto) String ¶
func (x *JinaInfoProto) String() string
type JinaInfoRPCClient ¶
type JinaInfoRPCClient interface {
XStatus(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*JinaInfoProto, error)
}
JinaInfoRPCClient is the client API for JinaInfoRPC service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewJinaInfoRPCClient ¶
func NewJinaInfoRPCClient(cc grpc.ClientConnInterface) JinaInfoRPCClient
type JinaInfoRPCServer ¶
type JinaInfoRPCServer interface { XStatus(context.Context, *emptypb.Empty) (*JinaInfoProto, error) // contains filtered or unexported methods }
JinaInfoRPCServer is the server API for JinaInfoRPC service. All implementations must embed UnimplementedJinaInfoRPCServer for forward compatibility
type JinaRPCClient ¶
type JinaRPCClient interface { // Pass in a Request and a filled Request with matches will be returned. Call(ctx context.Context, opts ...grpc.CallOption) (JinaRPC_CallClient, error) }
JinaRPCClient is the client API for JinaRPC service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewJinaRPCClient ¶
func NewJinaRPCClient(cc grpc.ClientConnInterface) JinaRPCClient
type JinaRPCServer ¶
type JinaRPCServer interface { // Pass in a Request and a filled Request with matches will be returned. Call(JinaRPC_CallServer) error // contains filtered or unexported methods }
JinaRPCServer is the server API for JinaRPC service. All implementations must embed UnimplementedJinaRPCServer for forward compatibility
type JinaRPC_CallClient ¶
type JinaRPC_CallClient interface { Send(*DataRequestProto) error Recv() (*DataRequestProto, error) grpc.ClientStream }
type JinaRPC_CallServer ¶
type JinaRPC_CallServer interface { Send(*DataRequestProto) error Recv() (*DataRequestProto, error) grpc.ServerStream }
type JinaSingleDataRequestRPCClient ¶
type JinaSingleDataRequestRPCClient interface { // Used for passing DataRequests to the Executors ProcessSingleData(ctx context.Context, in *DataRequestProto, opts ...grpc.CallOption) (*DataRequestProto, error) }
JinaSingleDataRequestRPCClient is the client API for JinaSingleDataRequestRPC service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewJinaSingleDataRequestRPCClient ¶
func NewJinaSingleDataRequestRPCClient(cc grpc.ClientConnInterface) JinaSingleDataRequestRPCClient
type JinaSingleDataRequestRPCServer ¶
type JinaSingleDataRequestRPCServer interface { // Used for passing DataRequests to the Executors ProcessSingleData(context.Context, *DataRequestProto) (*DataRequestProto, error) // contains filtered or unexported methods }
JinaSingleDataRequestRPCServer is the server API for JinaSingleDataRequestRPC service. All implementations must embed UnimplementedJinaSingleDataRequestRPCServer for forward compatibility
type RelatedEntity ¶
type RelatedEntity struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // unique id of the entity, like the name of a pod Address string `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"` // address of the entity, could be an IP address, domain name etc, does not include port Port uint32 `protobuf:"varint,3,opt,name=port,proto3" json:"port,omitempty"` // port this entity is listening on ShardId *uint32 `protobuf:"varint,4,opt,name=shard_id,json=shardId,proto3,oneof" json:"shard_id,omitempty"` // the id of the shard it belongs to, if it is a shard // contains filtered or unexported fields }
* Represents an entity (like an ExecutorRuntime)
func (*RelatedEntity) Descriptor
deprecated
func (*RelatedEntity) Descriptor() ([]byte, []int)
Deprecated: Use RelatedEntity.ProtoReflect.Descriptor instead.
func (*RelatedEntity) GetAddress ¶
func (x *RelatedEntity) GetAddress() string
func (*RelatedEntity) GetId ¶
func (x *RelatedEntity) GetId() string
func (*RelatedEntity) GetPort ¶
func (x *RelatedEntity) GetPort() uint32
func (*RelatedEntity) GetShardId ¶
func (x *RelatedEntity) GetShardId() uint32
func (*RelatedEntity) ProtoMessage ¶
func (*RelatedEntity) ProtoMessage()
func (*RelatedEntity) ProtoReflect ¶
func (x *RelatedEntity) ProtoReflect() protoreflect.Message
func (*RelatedEntity) Reset ¶
func (x *RelatedEntity) Reset()
func (*RelatedEntity) String ¶
func (x *RelatedEntity) String() string
type RouteProto ¶
type RouteProto struct { Executor string `protobuf:"bytes,1,opt,name=executor,proto3" json:"executor,omitempty"` // the name of the BasePod StartTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"` // time when the Gateway starts sending to the Pod EndTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"` // time when the Gateway received it from the Pod Status *StatusProto `protobuf:"bytes,4,opt,name=status,proto3" json:"status,omitempty"` // the status of the execution // contains filtered or unexported fields }
* 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
func (*RouteProto) Descriptor
deprecated
func (*RouteProto) Descriptor() ([]byte, []int)
Deprecated: Use RouteProto.ProtoReflect.Descriptor instead.
func (*RouteProto) GetEndTime ¶
func (x *RouteProto) GetEndTime() *timestamppb.Timestamp
func (*RouteProto) GetExecutor ¶
func (x *RouteProto) GetExecutor() string
func (*RouteProto) GetStartTime ¶
func (x *RouteProto) GetStartTime() *timestamppb.Timestamp
func (*RouteProto) GetStatus ¶
func (x *RouteProto) GetStatus() *StatusProto
func (*RouteProto) MarshalJSON ¶
func (x *RouteProto) MarshalJSON() ([]byte, error)
Custom JSON marshalling for RouteProto
func (*RouteProto) ProtoMessage ¶
func (*RouteProto) ProtoMessage()
func (*RouteProto) ProtoReflect ¶
func (x *RouteProto) ProtoReflect() protoreflect.Message
func (*RouteProto) Reset ¶
func (x *RouteProto) Reset()
func (*RouteProto) String ¶
func (x *RouteProto) String() string
func (*RouteProto) UnmarshalJSON ¶
func (x *RouteProto) UnmarshalJSON(data []byte) error
Custom JSON unmarshalling for RouteProto
type StatusProto ¶
type StatusProto struct { // status code Code StatusProto_StatusCode `protobuf:"varint,1,opt,name=code,proto3,enum=jina.StatusProto_StatusCode" json:"code,omitempty"` // error description of the very first exception Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` // the details of the error Exception *StatusProto_ExceptionProto `protobuf:"bytes,3,opt,name=exception,proto3" json:"exception,omitempty"` // contains filtered or unexported fields }
* Represents a Status
func (*StatusProto) Descriptor
deprecated
func (*StatusProto) Descriptor() ([]byte, []int)
Deprecated: Use StatusProto.ProtoReflect.Descriptor instead.
func (*StatusProto) GetCode ¶
func (x *StatusProto) GetCode() StatusProto_StatusCode
func (*StatusProto) GetDescription ¶
func (x *StatusProto) GetDescription() string
func (*StatusProto) GetException ¶
func (x *StatusProto) GetException() *StatusProto_ExceptionProto
func (*StatusProto) ProtoMessage ¶
func (*StatusProto) ProtoMessage()
func (*StatusProto) ProtoReflect ¶
func (x *StatusProto) ProtoReflect() protoreflect.Message
func (*StatusProto) Reset ¶
func (x *StatusProto) Reset()
func (*StatusProto) String ¶
func (x *StatusProto) String() string
type StatusProto_ExceptionProto ¶
type StatusProto_ExceptionProto struct { // the class name of the exception Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // the list of arguments given to the exception constructor. Args []string `protobuf:"bytes,2,rep,name=args,proto3" json:"args,omitempty"` // the exception traceback stacks Stacks []string `protobuf:"bytes,3,rep,name=stacks,proto3" json:"stacks,omitempty"` // the name of the executor bind to that Executor (if applicable) Executor string `protobuf:"bytes,4,opt,name=executor,proto3" json:"executor,omitempty"` // contains filtered or unexported fields }
func (*StatusProto_ExceptionProto) Descriptor
deprecated
func (*StatusProto_ExceptionProto) Descriptor() ([]byte, []int)
Deprecated: Use StatusProto_ExceptionProto.ProtoReflect.Descriptor instead.
func (*StatusProto_ExceptionProto) GetArgs ¶
func (x *StatusProto_ExceptionProto) GetArgs() []string
func (*StatusProto_ExceptionProto) GetExecutor ¶
func (x *StatusProto_ExceptionProto) GetExecutor() string
func (*StatusProto_ExceptionProto) GetName ¶
func (x *StatusProto_ExceptionProto) GetName() string
func (*StatusProto_ExceptionProto) GetStacks ¶
func (x *StatusProto_ExceptionProto) GetStacks() []string
func (*StatusProto_ExceptionProto) ProtoMessage ¶
func (*StatusProto_ExceptionProto) ProtoMessage()
func (*StatusProto_ExceptionProto) ProtoReflect ¶
func (x *StatusProto_ExceptionProto) ProtoReflect() protoreflect.Message
func (*StatusProto_ExceptionProto) Reset ¶
func (x *StatusProto_ExceptionProto) Reset()
func (*StatusProto_ExceptionProto) String ¶
func (x *StatusProto_ExceptionProto) String() string
type StatusProto_StatusCode ¶
type StatusProto_StatusCode int32
const ( StatusProto_SUCCESS StatusProto_StatusCode = 0 // success StatusProto_ERROR StatusProto_StatusCode = 1 // error )
func (StatusProto_StatusCode) Descriptor ¶
func (StatusProto_StatusCode) Descriptor() protoreflect.EnumDescriptor
func (StatusProto_StatusCode) Enum ¶
func (x StatusProto_StatusCode) Enum() *StatusProto_StatusCode
func (StatusProto_StatusCode) EnumDescriptor
deprecated
func (StatusProto_StatusCode) EnumDescriptor() ([]byte, []int)
Deprecated: Use StatusProto_StatusCode.Descriptor instead.
func (StatusProto_StatusCode) Number ¶
func (x StatusProto_StatusCode) Number() protoreflect.EnumNumber
func (StatusProto_StatusCode) String ¶
func (x StatusProto_StatusCode) String() string
func (StatusProto_StatusCode) Type ¶
func (StatusProto_StatusCode) Type() protoreflect.EnumType
type UnimplementedJinaDataRequestRPCServer ¶
type UnimplementedJinaDataRequestRPCServer struct { }
UnimplementedJinaDataRequestRPCServer must be embedded to have forward compatible implementations.
func (UnimplementedJinaDataRequestRPCServer) ProcessData ¶
func (UnimplementedJinaDataRequestRPCServer) ProcessData(context.Context, *DataRequestListProto) (*DataRequestProto, error)
type UnimplementedJinaDiscoverEndpointsRPCServer ¶
type UnimplementedJinaDiscoverEndpointsRPCServer struct { }
UnimplementedJinaDiscoverEndpointsRPCServer must be embedded to have forward compatible implementations.
func (UnimplementedJinaDiscoverEndpointsRPCServer) EndpointDiscovery ¶
func (UnimplementedJinaDiscoverEndpointsRPCServer) EndpointDiscovery(context.Context, *emptypb.Empty) (*EndpointsProto, error)
type UnimplementedJinaGatewayDryRunRPCServer ¶
type UnimplementedJinaGatewayDryRunRPCServer struct { }
UnimplementedJinaGatewayDryRunRPCServer must be embedded to have forward compatible implementations.
func (UnimplementedJinaGatewayDryRunRPCServer) DryRun ¶
func (UnimplementedJinaGatewayDryRunRPCServer) DryRun(context.Context, *emptypb.Empty) (*StatusProto, error)
type UnimplementedJinaInfoRPCServer ¶
type UnimplementedJinaInfoRPCServer struct { }
UnimplementedJinaInfoRPCServer must be embedded to have forward compatible implementations.
func (UnimplementedJinaInfoRPCServer) XStatus ¶
func (UnimplementedJinaInfoRPCServer) XStatus(context.Context, *emptypb.Empty) (*JinaInfoProto, error)
type UnimplementedJinaRPCServer ¶
type UnimplementedJinaRPCServer struct { }
UnimplementedJinaRPCServer must be embedded to have forward compatible implementations.
func (UnimplementedJinaRPCServer) Call ¶
func (UnimplementedJinaRPCServer) Call(JinaRPC_CallServer) error
type UnimplementedJinaSingleDataRequestRPCServer ¶
type UnimplementedJinaSingleDataRequestRPCServer struct { }
UnimplementedJinaSingleDataRequestRPCServer must be embedded to have forward compatible implementations.
func (UnimplementedJinaSingleDataRequestRPCServer) ProcessSingleData ¶
func (UnimplementedJinaSingleDataRequestRPCServer) ProcessSingleData(context.Context, *DataRequestProto) (*DataRequestProto, error)
type UnsafeJinaDataRequestRPCServer ¶
type UnsafeJinaDataRequestRPCServer interface {
// contains filtered or unexported methods
}
UnsafeJinaDataRequestRPCServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to JinaDataRequestRPCServer will result in compilation errors.
type UnsafeJinaDiscoverEndpointsRPCServer ¶
type UnsafeJinaDiscoverEndpointsRPCServer interface {
// contains filtered or unexported methods
}
UnsafeJinaDiscoverEndpointsRPCServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to JinaDiscoverEndpointsRPCServer will result in compilation errors.
type UnsafeJinaGatewayDryRunRPCServer ¶
type UnsafeJinaGatewayDryRunRPCServer interface {
// contains filtered or unexported methods
}
UnsafeJinaGatewayDryRunRPCServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to JinaGatewayDryRunRPCServer will result in compilation errors.
type UnsafeJinaInfoRPCServer ¶
type UnsafeJinaInfoRPCServer interface {
// contains filtered or unexported methods
}
UnsafeJinaInfoRPCServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to JinaInfoRPCServer will result in compilation errors.
type UnsafeJinaRPCServer ¶
type UnsafeJinaRPCServer interface {
// contains filtered or unexported methods
}
UnsafeJinaRPCServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to JinaRPCServer will result in compilation errors.
type UnsafeJinaSingleDataRequestRPCServer ¶
type UnsafeJinaSingleDataRequestRPCServer interface {
// contains filtered or unexported methods
}
UnsafeJinaSingleDataRequestRPCServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to JinaSingleDataRequestRPCServer will result in compilation errors.