Documentation ¶
Index ¶
- func RegisterServiceServer(s *grpc.Server, srv ServiceServer)
- type EmitEventReply
- func (*EmitEventReply) Descriptor() ([]byte, []int)
- func (*EmitEventReply) ProtoMessage()
- func (m *EmitEventReply) Reset()
- func (m *EmitEventReply) String() string
- func (m *EmitEventReply) XXX_DiscardUnknown()
- func (m *EmitEventReply) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *EmitEventReply) XXX_Merge(src proto.Message)
- func (m *EmitEventReply) XXX_Size() int
- func (m *EmitEventReply) XXX_Unmarshal(b []byte) error
- type EmitEventRequest
- func (*EmitEventRequest) Descriptor() ([]byte, []int)
- func (m *EmitEventRequest) GetEventData() string
- func (m *EmitEventRequest) GetEventKey() string
- func (m *EmitEventRequest) GetToken() string
- func (*EmitEventRequest) ProtoMessage()
- func (m *EmitEventRequest) Reset()
- func (m *EmitEventRequest) String() string
- func (m *EmitEventRequest) XXX_DiscardUnknown()
- func (m *EmitEventRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *EmitEventRequest) XXX_Merge(src proto.Message)
- func (m *EmitEventRequest) XXX_Size() int
- func (m *EmitEventRequest) XXX_Unmarshal(b []byte) error
- type ListenTaskRequest
- func (*ListenTaskRequest) Descriptor() ([]byte, []int)
- func (m *ListenTaskRequest) GetToken() string
- func (*ListenTaskRequest) ProtoMessage()
- func (m *ListenTaskRequest) Reset()
- func (m *ListenTaskRequest) String() string
- func (m *ListenTaskRequest) XXX_DiscardUnknown()
- func (m *ListenTaskRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *ListenTaskRequest) XXX_Merge(src proto.Message)
- func (m *ListenTaskRequest) XXX_Size() int
- func (m *ListenTaskRequest) XXX_Unmarshal(b []byte) error
- type ServiceClient
- type ServiceServer
- type Service_ListenTaskClient
- type Service_ListenTaskServer
- type SubmitResultReply
- func (*SubmitResultReply) Descriptor() ([]byte, []int)
- func (*SubmitResultReply) ProtoMessage()
- func (m *SubmitResultReply) Reset()
- func (m *SubmitResultReply) String() string
- func (m *SubmitResultReply) XXX_DiscardUnknown()
- func (m *SubmitResultReply) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *SubmitResultReply) XXX_Merge(src proto.Message)
- func (m *SubmitResultReply) XXX_Size() int
- func (m *SubmitResultReply) XXX_Unmarshal(b []byte) error
- type SubmitResultRequest
- func (*SubmitResultRequest) Descriptor() ([]byte, []int)
- func (m *SubmitResultRequest) GetError() string
- func (m *SubmitResultRequest) GetExecutionHash() string
- func (m *SubmitResultRequest) GetOutputData() string
- func (m *SubmitResultRequest) GetResult() isSubmitResultRequest_Result
- func (*SubmitResultRequest) ProtoMessage()
- func (m *SubmitResultRequest) Reset()
- func (m *SubmitResultRequest) String() string
- func (m *SubmitResultRequest) XXX_DiscardUnknown()
- func (m *SubmitResultRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *SubmitResultRequest) XXX_Merge(src proto.Message)
- func (*SubmitResultRequest) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)
- func (m *SubmitResultRequest) XXX_Size() int
- func (m *SubmitResultRequest) XXX_Unmarshal(b []byte) error
- type SubmitResultRequest_Error
- type SubmitResultRequest_OutputData
- type TaskData
- func (*TaskData) Descriptor() ([]byte, []int)
- func (m *TaskData) GetExecutionHash() string
- func (m *TaskData) GetInputData() string
- func (m *TaskData) GetTaskKey() string
- func (*TaskData) ProtoMessage()
- func (m *TaskData) Reset()
- func (m *TaskData) String() string
- func (m *TaskData) XXX_DiscardUnknown()
- func (m *TaskData) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (dst *TaskData) XXX_Merge(src proto.Message)
- func (m *TaskData) XXX_Size() int
- func (m *TaskData) XXX_Unmarshal(b []byte) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RegisterServiceServer ¶
func RegisterServiceServer(s *grpc.Server, srv ServiceServer)
Types ¶
type EmitEventReply ¶
type EmitEventReply struct { XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Reply of `EmitEvent` API doesn't contain any data.
func (*EmitEventReply) Descriptor ¶
func (*EmitEventReply) Descriptor() ([]byte, []int)
func (*EmitEventReply) ProtoMessage ¶
func (*EmitEventReply) ProtoMessage()
func (*EmitEventReply) Reset ¶
func (m *EmitEventReply) Reset()
func (*EmitEventReply) String ¶
func (m *EmitEventReply) String() string
func (*EmitEventReply) XXX_DiscardUnknown ¶
func (m *EmitEventReply) XXX_DiscardUnknown()
func (*EmitEventReply) XXX_Marshal ¶
func (m *EmitEventReply) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*EmitEventReply) XXX_Merge ¶
func (dst *EmitEventReply) XXX_Merge(src proto.Message)
func (*EmitEventReply) XXX_Size ¶
func (m *EmitEventReply) XXX_Size() int
func (*EmitEventReply) XXX_Unmarshal ¶
func (m *EmitEventReply) XXX_Unmarshal(b []byte) error
type EmitEventRequest ¶
type EmitEventRequest struct { Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"` EventKey string `protobuf:"bytes,2,opt,name=eventKey,proto3" json:"eventKey,omitempty"` EventData string `protobuf:"bytes,3,opt,name=eventData,proto3" json:"eventData,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
The request's data for the `EmitEvent` API.
**Example:** ```json
{ "token": "__SERVICE_TOKEN_FROM_ENV__", "eventKey": "__EVENT_KEY__", "eventData": "{\"foo\":\"hello\",\"bar\":false}" }
```
func (*EmitEventRequest) Descriptor ¶
func (*EmitEventRequest) Descriptor() ([]byte, []int)
func (*EmitEventRequest) GetEventData ¶
func (m *EmitEventRequest) GetEventData() string
func (*EmitEventRequest) GetEventKey ¶
func (m *EmitEventRequest) GetEventKey() string
func (*EmitEventRequest) GetToken ¶
func (m *EmitEventRequest) GetToken() string
func (*EmitEventRequest) ProtoMessage ¶
func (*EmitEventRequest) ProtoMessage()
func (*EmitEventRequest) Reset ¶
func (m *EmitEventRequest) Reset()
func (*EmitEventRequest) String ¶
func (m *EmitEventRequest) String() string
func (*EmitEventRequest) XXX_DiscardUnknown ¶
func (m *EmitEventRequest) XXX_DiscardUnknown()
func (*EmitEventRequest) XXX_Marshal ¶
func (m *EmitEventRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*EmitEventRequest) XXX_Merge ¶
func (dst *EmitEventRequest) XXX_Merge(src proto.Message)
func (*EmitEventRequest) XXX_Size ¶
func (m *EmitEventRequest) XXX_Size() int
func (*EmitEventRequest) XXX_Unmarshal ¶
func (m *EmitEventRequest) XXX_Unmarshal(b []byte) error
type ListenTaskRequest ¶
type ListenTaskRequest struct { Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
The request's data for the `ListenTask` stream API.
**Example:** ```json
{ "token": "__SERVICE_TOKEN_FROM_ENV__" }
```
func (*ListenTaskRequest) Descriptor ¶
func (*ListenTaskRequest) Descriptor() ([]byte, []int)
func (*ListenTaskRequest) GetToken ¶
func (m *ListenTaskRequest) GetToken() string
func (*ListenTaskRequest) ProtoMessage ¶
func (*ListenTaskRequest) ProtoMessage()
func (*ListenTaskRequest) Reset ¶
func (m *ListenTaskRequest) Reset()
func (*ListenTaskRequest) String ¶
func (m *ListenTaskRequest) String() string
func (*ListenTaskRequest) XXX_DiscardUnknown ¶
func (m *ListenTaskRequest) XXX_DiscardUnknown()
func (*ListenTaskRequest) XXX_Marshal ¶
func (m *ListenTaskRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ListenTaskRequest) XXX_Merge ¶
func (dst *ListenTaskRequest) XXX_Merge(src proto.Message)
func (*ListenTaskRequest) XXX_Size ¶
func (m *ListenTaskRequest) XXX_Size() int
func (*ListenTaskRequest) XXX_Unmarshal ¶
func (m *ListenTaskRequest) XXX_Unmarshal(b []byte) error
type ServiceClient ¶
type ServiceClient interface { // Emit an event to Core. // The event and its data must be defined in the [service's definition file](../guide/service/service-file.md). EmitEvent(ctx context.Context, in *EmitEventRequest, opts ...grpc.CallOption) (*EmitEventReply, error) // Subscribe to the stream of tasks to execute. // Every task received must be executed and its result must be submitted using the `SubmitResult` API. ListenTask(ctx context.Context, in *ListenTaskRequest, opts ...grpc.CallOption) (Service_ListenTaskClient, error) // Submit the result of a task's execution to Core. // The result must be defined as a task's output in the [service's definition file](../guide/service/service-file.md). SubmitResult(ctx context.Context, in *SubmitResultRequest, opts ...grpc.CallOption) (*SubmitResultReply, error) }
ServiceClient is the client API for Service service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewServiceClient ¶
func NewServiceClient(cc *grpc.ClientConn) ServiceClient
type ServiceServer ¶
type ServiceServer interface { // Emit an event to Core. // The event and its data must be defined in the [service's definition file](../guide/service/service-file.md). EmitEvent(context.Context, *EmitEventRequest) (*EmitEventReply, error) // Subscribe to the stream of tasks to execute. // Every task received must be executed and its result must be submitted using the `SubmitResult` API. ListenTask(*ListenTaskRequest, Service_ListenTaskServer) error // Submit the result of a task's execution to Core. // The result must be defined as a task's output in the [service's definition file](../guide/service/service-file.md). SubmitResult(context.Context, *SubmitResultRequest) (*SubmitResultReply, error) }
ServiceServer is the server API for Service service.
type Service_ListenTaskClient ¶
type Service_ListenTaskClient interface { Recv() (*TaskData, error) grpc.ClientStream }
type Service_ListenTaskServer ¶
type Service_ListenTaskServer interface { Send(*TaskData) error grpc.ServerStream }
type SubmitResultReply ¶
type SubmitResultReply struct { XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Reply of `SubmitResult` API doesn't contain any data.
func (*SubmitResultReply) Descriptor ¶
func (*SubmitResultReply) Descriptor() ([]byte, []int)
func (*SubmitResultReply) ProtoMessage ¶
func (*SubmitResultReply) ProtoMessage()
func (*SubmitResultReply) Reset ¶
func (m *SubmitResultReply) Reset()
func (*SubmitResultReply) String ¶
func (m *SubmitResultReply) String() string
func (*SubmitResultReply) XXX_DiscardUnknown ¶
func (m *SubmitResultReply) XXX_DiscardUnknown()
func (*SubmitResultReply) XXX_Marshal ¶
func (m *SubmitResultReply) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*SubmitResultReply) XXX_Merge ¶
func (dst *SubmitResultReply) XXX_Merge(src proto.Message)
func (*SubmitResultReply) XXX_Size ¶
func (m *SubmitResultReply) XXX_Size() int
func (*SubmitResultReply) XXX_Unmarshal ¶
func (m *SubmitResultReply) XXX_Unmarshal(b []byte) error
type SubmitResultRequest ¶
type SubmitResultRequest struct { ExecutionHash string `protobuf:"bytes,1,opt,name=executionHash,proto3" json:"executionHash,omitempty"` // Types that are valid to be assigned to Result: // *SubmitResultRequest_OutputData // *SubmitResultRequest_Error Result isSubmitResultRequest_Result `protobuf_oneof:"result"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
The request's data for the `SubmitResult` API. The data must contain the `executionHash` of the executed task received from the stream of [`ListenTask` API](#listentask).
**Example:** ```json
{ "executionHash": "__EXECUTION_HASH__", "outputData": "{\"foo\":\"super result\",\"bar\":true}" "error": "{\"message\":\"some error\"}" }
```
func (*SubmitResultRequest) Descriptor ¶
func (*SubmitResultRequest) Descriptor() ([]byte, []int)
func (*SubmitResultRequest) GetError ¶ added in v0.10.0
func (m *SubmitResultRequest) GetError() string
func (*SubmitResultRequest) GetExecutionHash ¶ added in v0.10.0
func (m *SubmitResultRequest) GetExecutionHash() string
func (*SubmitResultRequest) GetOutputData ¶
func (m *SubmitResultRequest) GetOutputData() string
func (*SubmitResultRequest) GetResult ¶ added in v0.10.0
func (m *SubmitResultRequest) GetResult() isSubmitResultRequest_Result
func (*SubmitResultRequest) ProtoMessage ¶
func (*SubmitResultRequest) ProtoMessage()
func (*SubmitResultRequest) Reset ¶
func (m *SubmitResultRequest) Reset()
func (*SubmitResultRequest) String ¶
func (m *SubmitResultRequest) String() string
func (*SubmitResultRequest) XXX_DiscardUnknown ¶
func (m *SubmitResultRequest) XXX_DiscardUnknown()
func (*SubmitResultRequest) XXX_Marshal ¶
func (m *SubmitResultRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*SubmitResultRequest) XXX_Merge ¶
func (dst *SubmitResultRequest) XXX_Merge(src proto.Message)
func (*SubmitResultRequest) XXX_OneofFuncs ¶ added in v0.10.0
func (*SubmitResultRequest) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})
XXX_OneofFuncs is for the internal use of the proto package.
func (*SubmitResultRequest) XXX_Size ¶
func (m *SubmitResultRequest) XXX_Size() int
func (*SubmitResultRequest) XXX_Unmarshal ¶
func (m *SubmitResultRequest) XXX_Unmarshal(b []byte) error
type SubmitResultRequest_Error ¶ added in v0.10.0
type SubmitResultRequest_Error struct {
Error string `protobuf:"bytes,4,opt,name=error,proto3,oneof"`
}
type SubmitResultRequest_OutputData ¶ added in v0.10.0
type SubmitResultRequest_OutputData struct {
OutputData string `protobuf:"bytes,3,opt,name=outputData,proto3,oneof"`
}
type TaskData ¶
type TaskData struct { ExecutionHash string `protobuf:"bytes,1,opt,name=executionHash,proto3" json:"executionHash,omitempty"` TaskKey string `protobuf:"bytes,2,opt,name=taskKey,proto3" json:"taskKey,omitempty"` InputData string `protobuf:"bytes,3,opt,name=inputData,proto3" json:"inputData,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
The data received from the stream of the `ListenTask` API. The data will be received over time as long as the stream is open. The `executionHash` value must be kept and sent with the result when calling the [`SubmitResult` API](#submitresult).
**Example:** ```json
{ "executionHash": "__EXECUTION_HASH__", "taskKey": "__TASK_KEY__", "inputData": "{\"inputX\":\"Hello world!\",\"inputY\":true}" }
```
func (*TaskData) Descriptor ¶
func (*TaskData) GetExecutionHash ¶ added in v0.10.0
func (*TaskData) GetInputData ¶
func (*TaskData) GetTaskKey ¶
func (*TaskData) ProtoMessage ¶
func (*TaskData) ProtoMessage()
func (*TaskData) XXX_DiscardUnknown ¶
func (m *TaskData) XXX_DiscardUnknown()