Documentation
¶
Overview ¶
Package gateway is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Constants
- Variables
- func RegisterTaskServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterTaskServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client TaskServiceClient) error
- func RegisterTaskServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterTaskServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server TaskServiceServer) error
- func RegisterTaskServiceServer(s grpc.ServiceRegistrar, srv TaskServiceServer)
- type CreateTaskRequest
- func (*CreateTaskRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateTaskRequest) GetDescription() string
- func (x *CreateTaskRequest) GetDueDate() *timestamppb.Timestamp
- func (x *CreateTaskRequest) GetPriority() int32
- func (x *CreateTaskRequest) GetTitle() string
- func (*CreateTaskRequest) ProtoMessage()
- func (x *CreateTaskRequest) ProtoReflect() protoreflect.Message
- func (x *CreateTaskRequest) Reset()
- func (x *CreateTaskRequest) String() string
- type CreateTaskResponse
- type DeleteTaskRequest
- type DeleteTaskResponse
- type GetTaskRequest
- type GetTaskResponse
- func (*GetTaskResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetTaskResponse) GetCreatedAt() *timestamppb.Timestamp
- func (x *GetTaskResponse) GetDescription() string
- func (x *GetTaskResponse) GetDueDate() *timestamppb.Timestamp
- func (x *GetTaskResponse) GetId() string
- func (x *GetTaskResponse) GetPriority() int32
- func (x *GetTaskResponse) GetTitle() string
- func (*GetTaskResponse) ProtoMessage()
- func (x *GetTaskResponse) ProtoReflect() protoreflect.Message
- func (x *GetTaskResponse) Reset()
- func (x *GetTaskResponse) String() string
- type ListTasksRequest
- type ListTasksResponse
- type Task
- func (*Task) Descriptor() ([]byte, []int)deprecated
- func (x *Task) GetCreatedAt() *timestamppb.Timestamp
- func (x *Task) GetDescription() string
- func (x *Task) GetDueDate() *timestamppb.Timestamp
- func (x *Task) GetId() string
- func (x *Task) GetPriority() int32
- func (x *Task) GetTitle() string
- func (*Task) ProtoMessage()
- func (x *Task) ProtoReflect() protoreflect.Message
- func (x *Task) Reset()
- func (x *Task) String() string
- type TaskServiceClient
- type TaskServiceServer
- type UnimplementedTaskServiceServer
- func (UnimplementedTaskServiceServer) CreateTask(context.Context, *CreateTaskRequest) (*CreateTaskResponse, error)
- func (UnimplementedTaskServiceServer) DeleteTask(context.Context, *DeleteTaskRequest) (*DeleteTaskResponse, error)
- func (UnimplementedTaskServiceServer) GetTask(context.Context, *GetTaskRequest) (*GetTaskResponse, error)
- func (UnimplementedTaskServiceServer) ListTasks(context.Context, *ListTasksRequest) (*ListTasksResponse, error)
- func (UnimplementedTaskServiceServer) UpdateTask(context.Context, *UpdateTaskRequest) (*UpdateTaskResponse, error)
- type UnsafeTaskServiceServer
- type UpdateTaskRequest
- func (*UpdateTaskRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateTaskRequest) GetDescription() string
- func (x *UpdateTaskRequest) GetDueDate() *timestamppb.Timestamp
- func (x *UpdateTaskRequest) GetId() string
- func (x *UpdateTaskRequest) GetPriority() int32
- func (x *UpdateTaskRequest) GetTitle() string
- func (*UpdateTaskRequest) ProtoMessage()
- func (x *UpdateTaskRequest) ProtoReflect() protoreflect.Message
- func (x *UpdateTaskRequest) Reset()
- func (x *UpdateTaskRequest) String() string
- type UpdateTaskResponse
Constants ¶
const ( TaskService_GetTask_FullMethodName = "/task.TaskService/GetTask" TaskService_ListTasks_FullMethodName = "/task.TaskService/ListTasks" TaskService_CreateTask_FullMethodName = "/task.TaskService/CreateTask" TaskService_UpdateTask_FullMethodName = "/task.TaskService/UpdateTask" TaskService_DeleteTask_FullMethodName = "/task.TaskService/DeleteTask" )
Variables ¶
var File_task_proto protoreflect.FileDescriptor
var TaskService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "task.TaskService", HandlerType: (*TaskServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetTask", Handler: _TaskService_GetTask_Handler, }, { MethodName: "ListTasks", Handler: _TaskService_ListTasks_Handler, }, { MethodName: "CreateTask", Handler: _TaskService_CreateTask_Handler, }, { MethodName: "UpdateTask", Handler: _TaskService_UpdateTask_Handler, }, { MethodName: "DeleteTask", Handler: _TaskService_DeleteTask_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "task.proto", }
TaskService_ServiceDesc is the grpc.ServiceDesc for TaskService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterTaskServiceHandler ¶
func RegisterTaskServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterTaskServiceHandler registers the http handlers for service TaskService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterTaskServiceHandlerClient ¶
func RegisterTaskServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client TaskServiceClient) error
RegisterTaskServiceHandlerClient registers the http handlers for service TaskService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "TaskServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "TaskServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "TaskServiceClient" to call the correct interceptors. This client ignores the HTTP middlewares.
func RegisterTaskServiceHandlerFromEndpoint ¶
func RegisterTaskServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterTaskServiceHandlerFromEndpoint is same as RegisterTaskServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterTaskServiceHandlerServer ¶
func RegisterTaskServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server TaskServiceServer) error
RegisterTaskServiceHandlerServer registers the http handlers for service TaskService to "mux". UnaryRPC :call TaskServiceServer 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 RegisterTaskServiceHandlerFromEndpoint instead. GRPC interceptors will not work for this type of registration. To use interceptors, you must use the "runtime.WithMiddlewares" option in the "runtime.NewServeMux" call.
func RegisterTaskServiceServer ¶
func RegisterTaskServiceServer(s grpc.ServiceRegistrar, srv TaskServiceServer)
Types ¶
type CreateTaskRequest ¶
type CreateTaskRequest struct { Title string `protobuf:"bytes,1,opt,name=title,proto3" json:"title,omitempty"` Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` DueDate *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=due_date,json=dueDate,proto3" json:"due_date,omitempty"` Priority int32 `protobuf:"varint,4,opt,name=priority,proto3" json:"priority,omitempty"` // contains filtered or unexported fields }
func (*CreateTaskRequest) Descriptor
deprecated
func (*CreateTaskRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateTaskRequest.ProtoReflect.Descriptor instead.
func (*CreateTaskRequest) GetDescription ¶
func (x *CreateTaskRequest) GetDescription() string
func (*CreateTaskRequest) GetDueDate ¶
func (x *CreateTaskRequest) GetDueDate() *timestamppb.Timestamp
func (*CreateTaskRequest) GetPriority ¶
func (x *CreateTaskRequest) GetPriority() int32
func (*CreateTaskRequest) GetTitle ¶
func (x *CreateTaskRequest) GetTitle() string
func (*CreateTaskRequest) ProtoMessage ¶
func (*CreateTaskRequest) ProtoMessage()
func (*CreateTaskRequest) ProtoReflect ¶
func (x *CreateTaskRequest) ProtoReflect() protoreflect.Message
func (*CreateTaskRequest) Reset ¶
func (x *CreateTaskRequest) Reset()
func (*CreateTaskRequest) String ¶
func (x *CreateTaskRequest) String() string
type CreateTaskResponse ¶
type CreateTaskResponse struct {
// contains filtered or unexported fields
}
func (*CreateTaskResponse) Descriptor
deprecated
func (*CreateTaskResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateTaskResponse.ProtoReflect.Descriptor instead.
func (*CreateTaskResponse) ProtoMessage ¶
func (*CreateTaskResponse) ProtoMessage()
func (*CreateTaskResponse) ProtoReflect ¶
func (x *CreateTaskResponse) ProtoReflect() protoreflect.Message
func (*CreateTaskResponse) Reset ¶
func (x *CreateTaskResponse) Reset()
func (*CreateTaskResponse) String ¶
func (x *CreateTaskResponse) String() string
type DeleteTaskRequest ¶
type DeleteTaskRequest struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // contains filtered or unexported fields }
func (*DeleteTaskRequest) Descriptor
deprecated
func (*DeleteTaskRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteTaskRequest.ProtoReflect.Descriptor instead.
func (*DeleteTaskRequest) GetId ¶
func (x *DeleteTaskRequest) GetId() string
func (*DeleteTaskRequest) ProtoMessage ¶
func (*DeleteTaskRequest) ProtoMessage()
func (*DeleteTaskRequest) ProtoReflect ¶
func (x *DeleteTaskRequest) ProtoReflect() protoreflect.Message
func (*DeleteTaskRequest) Reset ¶
func (x *DeleteTaskRequest) Reset()
func (*DeleteTaskRequest) String ¶
func (x *DeleteTaskRequest) String() string
type DeleteTaskResponse ¶
type DeleteTaskResponse struct {
// contains filtered or unexported fields
}
func (*DeleteTaskResponse) Descriptor
deprecated
func (*DeleteTaskResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeleteTaskResponse.ProtoReflect.Descriptor instead.
func (*DeleteTaskResponse) ProtoMessage ¶
func (*DeleteTaskResponse) ProtoMessage()
func (*DeleteTaskResponse) ProtoReflect ¶
func (x *DeleteTaskResponse) ProtoReflect() protoreflect.Message
func (*DeleteTaskResponse) Reset ¶
func (x *DeleteTaskResponse) Reset()
func (*DeleteTaskResponse) String ¶
func (x *DeleteTaskResponse) String() string
type GetTaskRequest ¶
type GetTaskRequest struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // contains filtered or unexported fields }
func (*GetTaskRequest) Descriptor
deprecated
func (*GetTaskRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetTaskRequest.ProtoReflect.Descriptor instead.
func (*GetTaskRequest) GetId ¶
func (x *GetTaskRequest) GetId() string
func (*GetTaskRequest) ProtoMessage ¶
func (*GetTaskRequest) ProtoMessage()
func (*GetTaskRequest) ProtoReflect ¶
func (x *GetTaskRequest) ProtoReflect() protoreflect.Message
func (*GetTaskRequest) Reset ¶
func (x *GetTaskRequest) Reset()
func (*GetTaskRequest) String ¶
func (x *GetTaskRequest) String() string
type GetTaskResponse ¶
type GetTaskResponse struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"` Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"` DueDate *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=due_date,json=dueDate,proto3" json:"due_date,omitempty"` Priority int32 `protobuf:"varint,5,opt,name=priority,proto3" json:"priority,omitempty"` CreatedAt *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` // contains filtered or unexported fields }
func (*GetTaskResponse) Descriptor
deprecated
func (*GetTaskResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetTaskResponse.ProtoReflect.Descriptor instead.
func (*GetTaskResponse) GetCreatedAt ¶
func (x *GetTaskResponse) GetCreatedAt() *timestamppb.Timestamp
func (*GetTaskResponse) GetDescription ¶
func (x *GetTaskResponse) GetDescription() string
func (*GetTaskResponse) GetDueDate ¶
func (x *GetTaskResponse) GetDueDate() *timestamppb.Timestamp
func (*GetTaskResponse) GetId ¶
func (x *GetTaskResponse) GetId() string
func (*GetTaskResponse) GetPriority ¶
func (x *GetTaskResponse) GetPriority() int32
func (*GetTaskResponse) GetTitle ¶
func (x *GetTaskResponse) GetTitle() string
func (*GetTaskResponse) ProtoMessage ¶
func (*GetTaskResponse) ProtoMessage()
func (*GetTaskResponse) ProtoReflect ¶
func (x *GetTaskResponse) ProtoReflect() protoreflect.Message
func (*GetTaskResponse) Reset ¶
func (x *GetTaskResponse) Reset()
func (*GetTaskResponse) String ¶
func (x *GetTaskResponse) String() string
type ListTasksRequest ¶
type ListTasksRequest struct {
// contains filtered or unexported fields
}
func (*ListTasksRequest) Descriptor
deprecated
func (*ListTasksRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListTasksRequest.ProtoReflect.Descriptor instead.
func (*ListTasksRequest) ProtoMessage ¶
func (*ListTasksRequest) ProtoMessage()
func (*ListTasksRequest) ProtoReflect ¶
func (x *ListTasksRequest) ProtoReflect() protoreflect.Message
func (*ListTasksRequest) Reset ¶
func (x *ListTasksRequest) Reset()
func (*ListTasksRequest) String ¶
func (x *ListTasksRequest) String() string
type ListTasksResponse ¶
type ListTasksResponse struct { Tasks []*Task `protobuf:"bytes,1,rep,name=tasks,proto3" json:"tasks,omitempty"` // contains filtered or unexported fields }
func (*ListTasksResponse) Descriptor
deprecated
func (*ListTasksResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListTasksResponse.ProtoReflect.Descriptor instead.
func (*ListTasksResponse) GetTasks ¶
func (x *ListTasksResponse) GetTasks() []*Task
func (*ListTasksResponse) ProtoMessage ¶
func (*ListTasksResponse) ProtoMessage()
func (*ListTasksResponse) ProtoReflect ¶
func (x *ListTasksResponse) ProtoReflect() protoreflect.Message
func (*ListTasksResponse) Reset ¶
func (x *ListTasksResponse) Reset()
func (*ListTasksResponse) String ¶
func (x *ListTasksResponse) String() string
type Task ¶
type Task struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"` Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"` DueDate *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=due_date,json=dueDate,proto3" json:"due_date,omitempty"` Priority int32 `protobuf:"varint,5,opt,name=priority,proto3" json:"priority,omitempty"` CreatedAt *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"` // contains filtered or unexported fields }
func (*Task) Descriptor
deprecated
func (*Task) GetCreatedAt ¶
func (x *Task) GetCreatedAt() *timestamppb.Timestamp
func (*Task) GetDescription ¶
func (*Task) GetDueDate ¶
func (x *Task) GetDueDate() *timestamppb.Timestamp
func (*Task) GetPriority ¶
func (*Task) ProtoMessage ¶
func (*Task) ProtoMessage()
func (*Task) ProtoReflect ¶
func (x *Task) ProtoReflect() protoreflect.Message
type TaskServiceClient ¶
type TaskServiceClient interface { GetTask(ctx context.Context, in *GetTaskRequest, opts ...grpc.CallOption) (*GetTaskResponse, error) ListTasks(ctx context.Context, in *ListTasksRequest, opts ...grpc.CallOption) (*ListTasksResponse, error) CreateTask(ctx context.Context, in *CreateTaskRequest, opts ...grpc.CallOption) (*CreateTaskResponse, error) UpdateTask(ctx context.Context, in *UpdateTaskRequest, opts ...grpc.CallOption) (*UpdateTaskResponse, error) DeleteTask(ctx context.Context, in *DeleteTaskRequest, opts ...grpc.CallOption) (*DeleteTaskResponse, error) }
TaskServiceClient is the client API for TaskService 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 NewTaskServiceClient ¶
func NewTaskServiceClient(cc grpc.ClientConnInterface) TaskServiceClient
type TaskServiceServer ¶
type TaskServiceServer interface { GetTask(context.Context, *GetTaskRequest) (*GetTaskResponse, error) ListTasks(context.Context, *ListTasksRequest) (*ListTasksResponse, error) CreateTask(context.Context, *CreateTaskRequest) (*CreateTaskResponse, error) UpdateTask(context.Context, *UpdateTaskRequest) (*UpdateTaskResponse, error) DeleteTask(context.Context, *DeleteTaskRequest) (*DeleteTaskResponse, error) // contains filtered or unexported methods }
TaskServiceServer is the server API for TaskService service. All implementations must embed UnimplementedTaskServiceServer for forward compatibility
type UnimplementedTaskServiceServer ¶
type UnimplementedTaskServiceServer struct{}
UnimplementedTaskServiceServer must be embedded to have forward compatible implementations.
func (UnimplementedTaskServiceServer) CreateTask ¶
func (UnimplementedTaskServiceServer) CreateTask(context.Context, *CreateTaskRequest) (*CreateTaskResponse, error)
func (UnimplementedTaskServiceServer) DeleteTask ¶
func (UnimplementedTaskServiceServer) DeleteTask(context.Context, *DeleteTaskRequest) (*DeleteTaskResponse, error)
func (UnimplementedTaskServiceServer) GetTask ¶
func (UnimplementedTaskServiceServer) GetTask(context.Context, *GetTaskRequest) (*GetTaskResponse, error)
func (UnimplementedTaskServiceServer) ListTasks ¶
func (UnimplementedTaskServiceServer) ListTasks(context.Context, *ListTasksRequest) (*ListTasksResponse, error)
func (UnimplementedTaskServiceServer) UpdateTask ¶
func (UnimplementedTaskServiceServer) UpdateTask(context.Context, *UpdateTaskRequest) (*UpdateTaskResponse, error)
type UnsafeTaskServiceServer ¶
type UnsafeTaskServiceServer interface {
// contains filtered or unexported methods
}
UnsafeTaskServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to TaskServiceServer will result in compilation errors.
type UpdateTaskRequest ¶
type UpdateTaskRequest struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"` Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"` DueDate *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=due_date,json=dueDate,proto3" json:"due_date,omitempty"` Priority int32 `protobuf:"varint,5,opt,name=priority,proto3" json:"priority,omitempty"` // contains filtered or unexported fields }
func (*UpdateTaskRequest) Descriptor
deprecated
func (*UpdateTaskRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateTaskRequest.ProtoReflect.Descriptor instead.
func (*UpdateTaskRequest) GetDescription ¶
func (x *UpdateTaskRequest) GetDescription() string
func (*UpdateTaskRequest) GetDueDate ¶
func (x *UpdateTaskRequest) GetDueDate() *timestamppb.Timestamp
func (*UpdateTaskRequest) GetId ¶
func (x *UpdateTaskRequest) GetId() string
func (*UpdateTaskRequest) GetPriority ¶
func (x *UpdateTaskRequest) GetPriority() int32
func (*UpdateTaskRequest) GetTitle ¶
func (x *UpdateTaskRequest) GetTitle() string
func (*UpdateTaskRequest) ProtoMessage ¶
func (*UpdateTaskRequest) ProtoMessage()
func (*UpdateTaskRequest) ProtoReflect ¶
func (x *UpdateTaskRequest) ProtoReflect() protoreflect.Message
func (*UpdateTaskRequest) Reset ¶
func (x *UpdateTaskRequest) Reset()
func (*UpdateTaskRequest) String ¶
func (x *UpdateTaskRequest) String() string
type UpdateTaskResponse ¶
type UpdateTaskResponse struct {
// contains filtered or unexported fields
}
func (*UpdateTaskResponse) Descriptor
deprecated
func (*UpdateTaskResponse) Descriptor() ([]byte, []int)
Deprecated: Use UpdateTaskResponse.ProtoReflect.Descriptor instead.
func (*UpdateTaskResponse) ProtoMessage ¶
func (*UpdateTaskResponse) ProtoMessage()
func (*UpdateTaskResponse) ProtoReflect ¶
func (x *UpdateTaskResponse) ProtoReflect() protoreflect.Message
func (*UpdateTaskResponse) Reset ¶
func (x *UpdateTaskResponse) Reset()
func (*UpdateTaskResponse) String ¶
func (x *UpdateTaskResponse) String() string