Documentation ¶
Overview ¶
Package scheduler is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Constants
- Variables
- func RegisterSchedulerHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterSchedulerHandlerClient(ctx context.Context, mux *runtime.ServeMux, client SchedulerClient) error
- func RegisterSchedulerHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterSchedulerHandlerServer(ctx context.Context, mux *runtime.ServeMux, server SchedulerServer) error
- func RegisterSchedulerServer(s grpc.ServiceRegistrar, srv SchedulerServer)
- type ListRequest
- func (*ListRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListRequest) GetFilters() *io.Filters
- func (x *ListRequest) GetJobId() string
- func (*ListRequest) ProtoMessage()
- func (x *ListRequest) ProtoReflect() protoreflect.Message
- func (x *ListRequest) Reset()
- func (x *ListRequest) String() string
- type SchedulerClient
- type SchedulerServer
- type Scheduler_ListSchedulingJobHistoriesClient
- type Scheduler_ListSchedulingJobHistoriesServer
- type UnimplementedSchedulerServer
- func (UnimplementedSchedulerServer) CreateSchedulingJob(context.Context, *ct.SchedulingJob) (*ct.SchedulingJobResponse, error)
- func (UnimplementedSchedulerServer) DeleteSchedulingJob(context.Context, *io.Id) (*emptypb.Empty, error)
- func (UnimplementedSchedulerServer) GetSchedulingJob(context.Context, *io.Id) (*ct.SchedulingJob, error)
- func (UnimplementedSchedulerServer) GetSchedulingJobHistory(context.Context, *io.Id) (*ct.JobHistory, error)
- func (UnimplementedSchedulerServer) ListSchedulingJobHistories(*ListRequest, Scheduler_ListSchedulingJobHistoriesServer) error
- func (UnimplementedSchedulerServer) PatchSchedulingJob(context.Context, *ct.SchedulingJob) (*ct.SchedulingJobResponse, error)
- func (UnimplementedSchedulerServer) UpdateSchedulingJob(context.Context, *ct.SchedulingJob) (*ct.SchedulingJobResponse, error)
- type UnsafeSchedulerServer
Constants ¶
const ( Scheduler_CreateSchedulingJob_FullMethodName = "/scheduler.Scheduler/createSchedulingJob" Scheduler_GetSchedulingJob_FullMethodName = "/scheduler.Scheduler/getSchedulingJob" Scheduler_UpdateSchedulingJob_FullMethodName = "/scheduler.Scheduler/updateSchedulingJob" Scheduler_PatchSchedulingJob_FullMethodName = "/scheduler.Scheduler/patchSchedulingJob" Scheduler_DeleteSchedulingJob_FullMethodName = "/scheduler.Scheduler/deleteSchedulingJob" Scheduler_GetSchedulingJobHistory_FullMethodName = "/scheduler.Scheduler/getSchedulingJobHistory" Scheduler_ListSchedulingJobHistories_FullMethodName = "/scheduler.Scheduler/listSchedulingJobHistories" )
Variables ¶
var File_io_scheduler_a_rpc_proto protoreflect.FileDescriptor
var File_io_scheduler_scheduler_proto protoreflect.FileDescriptor
var Scheduler_ServiceDesc = grpc.ServiceDesc{ ServiceName: "scheduler.Scheduler", HandlerType: (*SchedulerServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "createSchedulingJob", Handler: _Scheduler_CreateSchedulingJob_Handler, }, { MethodName: "getSchedulingJob", Handler: _Scheduler_GetSchedulingJob_Handler, }, { MethodName: "updateSchedulingJob", Handler: _Scheduler_UpdateSchedulingJob_Handler, }, { MethodName: "patchSchedulingJob", Handler: _Scheduler_PatchSchedulingJob_Handler, }, { MethodName: "deleteSchedulingJob", Handler: _Scheduler_DeleteSchedulingJob_Handler, }, { MethodName: "getSchedulingJobHistory", Handler: _Scheduler_GetSchedulingJobHistory_Handler, }, }, Streams: []grpc.StreamDesc{ { StreamName: "listSchedulingJobHistories", Handler: _Scheduler_ListSchedulingJobHistories_Handler, ServerStreams: true, }, }, Metadata: "io/scheduler/a_rpc.proto", }
Scheduler_ServiceDesc is the grpc.ServiceDesc for Scheduler service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterSchedulerHandler ¶
func RegisterSchedulerHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterSchedulerHandler registers the http handlers for service Scheduler to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterSchedulerHandlerClient ¶
func RegisterSchedulerHandlerClient(ctx context.Context, mux *runtime.ServeMux, client SchedulerClient) error
RegisterSchedulerHandlerClient registers the http handlers for service Scheduler to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "SchedulerClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "SchedulerClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "SchedulerClient" to call the correct interceptors.
func RegisterSchedulerHandlerFromEndpoint ¶
func RegisterSchedulerHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterSchedulerHandlerFromEndpoint is same as RegisterSchedulerHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterSchedulerHandlerServer ¶
func RegisterSchedulerHandlerServer(ctx context.Context, mux *runtime.ServeMux, server SchedulerServer) error
RegisterSchedulerHandlerServer registers the http handlers for service Scheduler to "mux". UnaryRPC :call SchedulerServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterSchedulerHandlerFromEndpoint instead.
func RegisterSchedulerServer ¶
func RegisterSchedulerServer(s grpc.ServiceRegistrar, srv SchedulerServer)
Types ¶
type ListRequest ¶
type ListRequest struct { // The id of SchedulingJob. // @tag: validateGeneric:"required" JobId string `protobuf:"bytes,1,opt,name=jobId,proto3" json:"jobId,omitempty" validateGeneric:"required"` // Search filters. // @tag: validateGeneric:"omitempty" Filters *io.Filters `protobuf:"bytes,2,opt,name=filters,proto3" json:"filters,omitempty" validateGeneric:"omitempty"` // contains filtered or unexported fields }
func (*ListRequest) Descriptor
deprecated
func (*ListRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListRequest.ProtoReflect.Descriptor instead.
func (*ListRequest) GetFilters ¶
func (x *ListRequest) GetFilters() *io.Filters
func (*ListRequest) GetJobId ¶
func (x *ListRequest) GetJobId() string
func (*ListRequest) ProtoMessage ¶
func (*ListRequest) ProtoMessage()
func (*ListRequest) ProtoReflect ¶
func (x *ListRequest) ProtoReflect() protoreflect.Message
func (*ListRequest) Reset ¶
func (x *ListRequest) Reset()
func (*ListRequest) String ¶
func (x *ListRequest) String() string
type SchedulerClient ¶
type SchedulerClient interface { CreateSchedulingJob(ctx context.Context, in *ct.SchedulingJob, opts ...grpc.CallOption) (*ct.SchedulingJobResponse, error) GetSchedulingJob(ctx context.Context, in *io.Id, opts ...grpc.CallOption) (*ct.SchedulingJob, error) UpdateSchedulingJob(ctx context.Context, in *ct.SchedulingJob, opts ...grpc.CallOption) (*ct.SchedulingJobResponse, error) PatchSchedulingJob(ctx context.Context, in *ct.SchedulingJob, opts ...grpc.CallOption) (*ct.SchedulingJobResponse, error) DeleteSchedulingJob(ctx context.Context, in *io.Id, opts ...grpc.CallOption) (*emptypb.Empty, error) GetSchedulingJobHistory(ctx context.Context, in *io.Id, opts ...grpc.CallOption) (*ct.JobHistory, error) ListSchedulingJobHistories(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (Scheduler_ListSchedulingJobHistoriesClient, error) }
SchedulerClient is the client API for Scheduler 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 NewSchedulerClient ¶
func NewSchedulerClient(cc grpc.ClientConnInterface) SchedulerClient
type SchedulerServer ¶
type SchedulerServer interface { CreateSchedulingJob(context.Context, *ct.SchedulingJob) (*ct.SchedulingJobResponse, error) GetSchedulingJob(context.Context, *io.Id) (*ct.SchedulingJob, error) UpdateSchedulingJob(context.Context, *ct.SchedulingJob) (*ct.SchedulingJobResponse, error) PatchSchedulingJob(context.Context, *ct.SchedulingJob) (*ct.SchedulingJobResponse, error) DeleteSchedulingJob(context.Context, *io.Id) (*emptypb.Empty, error) GetSchedulingJobHistory(context.Context, *io.Id) (*ct.JobHistory, error) ListSchedulingJobHistories(*ListRequest, Scheduler_ListSchedulingJobHistoriesServer) error }
SchedulerServer is the server API for Scheduler service. All implementations should embed UnimplementedSchedulerServer for forward compatibility
type Scheduler_ListSchedulingJobHistoriesClient ¶
type Scheduler_ListSchedulingJobHistoriesClient interface { Recv() (*ct.JobHistory, error) grpc.ClientStream }
type Scheduler_ListSchedulingJobHistoriesServer ¶
type Scheduler_ListSchedulingJobHistoriesServer interface { Send(*ct.JobHistory) error grpc.ServerStream }
type UnimplementedSchedulerServer ¶
type UnimplementedSchedulerServer struct { }
UnimplementedSchedulerServer should be embedded to have forward compatible implementations.
func (UnimplementedSchedulerServer) CreateSchedulingJob ¶
func (UnimplementedSchedulerServer) CreateSchedulingJob(context.Context, *ct.SchedulingJob) (*ct.SchedulingJobResponse, error)
func (UnimplementedSchedulerServer) DeleteSchedulingJob ¶
func (UnimplementedSchedulerServer) GetSchedulingJob ¶
func (UnimplementedSchedulerServer) GetSchedulingJob(context.Context, *io.Id) (*ct.SchedulingJob, error)
func (UnimplementedSchedulerServer) GetSchedulingJobHistory ¶
func (UnimplementedSchedulerServer) GetSchedulingJobHistory(context.Context, *io.Id) (*ct.JobHistory, error)
func (UnimplementedSchedulerServer) ListSchedulingJobHistories ¶
func (UnimplementedSchedulerServer) ListSchedulingJobHistories(*ListRequest, Scheduler_ListSchedulingJobHistoriesServer) error
func (UnimplementedSchedulerServer) PatchSchedulingJob ¶
func (UnimplementedSchedulerServer) PatchSchedulingJob(context.Context, *ct.SchedulingJob) (*ct.SchedulingJobResponse, error)
func (UnimplementedSchedulerServer) UpdateSchedulingJob ¶
func (UnimplementedSchedulerServer) UpdateSchedulingJob(context.Context, *ct.SchedulingJob) (*ct.SchedulingJobResponse, error)
type UnsafeSchedulerServer ¶
type UnsafeSchedulerServer interface {
// contains filtered or unexported methods
}
UnsafeSchedulerServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SchedulerServer will result in compilation errors.