tasksv1

package
v0.7.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 19, 2024 License: MIT Imports: 19 Imported by: 0

Documentation

Overview

Package tasksv1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	TasksWriterService_CreateTask_FullMethodName   = "/api.tasks.v1.TasksWriterService/CreateTask"
	TasksWriterService_DeleteTask_FullMethodName   = "/api.tasks.v1.TasksWriterService/DeleteTask"
	TasksWriterService_UndeleteTask_FullMethodName = "/api.tasks.v1.TasksWriterService/UndeleteTask"
	TasksWriterService_UpdateTask_FullMethodName   = "/api.tasks.v1.TasksWriterService/UpdateTask"
)
View Source 
const (
	TasksReaderService_GetTask_FullMethodName   = "/api.tasks.v1.TasksReaderService/GetTask"
	TasksReaderService_ListTasks_FullMethodName = "/api.tasks.v1.TasksReaderService/ListTasks"
)

Variables

View Source 
var File_api_tasks_v1_tasks_proto protoreflect.FileDescriptor
View Source 
var TasksReaderService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "api.tasks.v1.TasksReaderService",
	HandlerType: (*TasksReaderServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetTask",
			Handler:    _TasksReaderService_GetTask_Handler,
		},
		{
			MethodName: "ListTasks",
			Handler:    _TasksReaderService_ListTasks_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "api/tasks/v1/tasks.proto",
}

TasksReaderService_ServiceDesc is the grpc.ServiceDesc for TasksReaderService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var TasksWriterService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "api.tasks.v1.TasksWriterService",
	HandlerType: (*TasksWriterServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateTask",
			Handler:    _TasksWriterService_CreateTask_Handler,
		},
		{
			MethodName: "DeleteTask",
			Handler:    _TasksWriterService_DeleteTask_Handler,
		},
		{
			MethodName: "UndeleteTask",
			Handler:    _TasksWriterService_UndeleteTask_Handler,
		},
		{
			MethodName: "UpdateTask",
			Handler:    _TasksWriterService_UpdateTask_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "api/tasks/v1/tasks.proto",
}

TasksWriterService_ServiceDesc is the grpc.ServiceDesc for TasksWriterService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterTasksReaderServiceHandler added in v0.5.0 

func RegisterTasksReaderServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterTasksReaderServiceHandler registers the http handlers for service TasksReaderService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterTasksReaderServiceHandlerClient added in v0.5.0 

func RegisterTasksReaderServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client TasksReaderServiceClient) error

RegisterTasksReaderServiceHandlerClient registers the http handlers for service TasksReaderService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "TasksReaderServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "TasksReaderServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "TasksReaderServiceClient" to call the correct interceptors.

func RegisterTasksReaderServiceHandlerFromEndpoint added in v0.5.0 

func RegisterTasksReaderServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterTasksReaderServiceHandlerFromEndpoint is same as RegisterTasksReaderServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterTasksReaderServiceHandlerServer added in v0.5.0 

func RegisterTasksReaderServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server TasksReaderServiceServer) error

RegisterTasksReaderServiceHandlerServer registers the http handlers for service TasksReaderService to "mux". UnaryRPC :call TasksReaderServiceServer 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 RegisterTasksReaderServiceHandlerFromEndpoint instead.

func RegisterTasksReaderServiceServer added in v0.5.0 

func RegisterTasksReaderServiceServer(s grpc.ServiceRegistrar, srv TasksReaderServiceServer)

func RegisterTasksWriterServiceHandler added in v0.5.0 

func RegisterTasksWriterServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterTasksWriterServiceHandler registers the http handlers for service TasksWriterService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterTasksWriterServiceHandlerClient added in v0.5.0 

func RegisterTasksWriterServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client TasksWriterServiceClient) error

RegisterTasksWriterServiceHandlerClient registers the http handlers for service TasksWriterService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "TasksWriterServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "TasksWriterServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "TasksWriterServiceClient" to call the correct interceptors.

func RegisterTasksWriterServiceHandlerFromEndpoint added in v0.5.0 

func RegisterTasksWriterServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterTasksWriterServiceHandlerFromEndpoint is same as RegisterTasksWriterServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterTasksWriterServiceHandlerServer added in v0.5.0 

func RegisterTasksWriterServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server TasksWriterServiceServer) error

RegisterTasksWriterServiceHandlerServer registers the http handlers for service TasksWriterService to "mux". UnaryRPC :call TasksWriterServiceServer 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 RegisterTasksWriterServiceHandlerFromEndpoint instead.

func RegisterTasksWriterServiceServer added in v0.5.0 

func RegisterTasksWriterServiceServer(s grpc.ServiceRegistrar, srv TasksWriterServiceServer)

Types

type CreateTaskRequest 

type CreateTaskRequest struct {

	// Task is the the task to create.
	Task *Task `protobuf:"bytes,2,opt,name=task,proto3" json:"task,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateTaskRequest) Descriptor deprecated 

func (*CreateTaskRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateTaskRequest.ProtoReflect.Descriptor instead.

func (*CreateTaskRequest) GetTask 

func (x *CreateTaskRequest) GetTask() *Task

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 DeleteTaskRequest added in v0.6.0 

type DeleteTaskRequest struct {
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteTaskRequest) Descriptor deprecated added in v0.6.0 

func (*DeleteTaskRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteTaskRequest.ProtoReflect.Descriptor instead.

func (*DeleteTaskRequest) GetId added in v0.6.0 

func (x *DeleteTaskRequest) GetId() int64

func (*DeleteTaskRequest) ProtoMessage added in v0.6.0 

func (*DeleteTaskRequest) ProtoMessage()

func (*DeleteTaskRequest) ProtoReflect added in v0.6.0 

func (x *DeleteTaskRequest) ProtoReflect() protoreflect.Message

func (*DeleteTaskRequest) Reset added in v0.6.0 

func (x *DeleteTaskRequest) Reset()

func (*DeleteTaskRequest) String added in v0.6.0 

func (x *DeleteTaskRequest) String() string

type GetTaskRequest added in v0.5.0 

type GetTaskRequest struct {
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetTaskRequest) Descriptor deprecated added in v0.5.0 

func (*GetTaskRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetTaskRequest.ProtoReflect.Descriptor instead.

func (*GetTaskRequest) GetId added in v0.5.0 

func (x *GetTaskRequest) GetId() int64

func (*GetTaskRequest) ProtoMessage added in v0.5.0 

func (*GetTaskRequest) ProtoMessage()

func (*GetTaskRequest) ProtoReflect added in v0.5.0 

func (x *GetTaskRequest) ProtoReflect() protoreflect.Message

func (*GetTaskRequest) Reset added in v0.5.0 

func (x *GetTaskRequest) Reset()

func (*GetTaskRequest) String added in v0.5.0 

func (x *GetTaskRequest) String() string

type ListTasksRequest added in v0.6.0 

type ListTasksRequest struct {
	PageSize  int32  `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListTasksRequest) Descriptor deprecated added in v0.6.0 

func (*ListTasksRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListTasksRequest.ProtoReflect.Descriptor instead.

func (*ListTasksRequest) GetPageSize added in v0.6.0 

func (x *ListTasksRequest) GetPageSize() int32

func (*ListTasksRequest) GetPageToken added in v0.6.0 

func (x *ListTasksRequest) GetPageToken() string

func (*ListTasksRequest) ProtoMessage added in v0.6.0 

func (*ListTasksRequest) ProtoMessage()

func (*ListTasksRequest) ProtoReflect added in v0.6.0 

func (x *ListTasksRequest) ProtoReflect() protoreflect.Message

func (*ListTasksRequest) Reset added in v0.6.0 

func (x *ListTasksRequest) Reset()

func (*ListTasksRequest) String added in v0.6.0 

func (x *ListTasksRequest) String() string

type ListTasksResponse added in v0.6.0 

type ListTasksResponse struct {
	Tasks         []*Task `protobuf:"bytes,1,rep,name=tasks,proto3" json:"tasks,omitempty"`
	NextPageToken string  `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListTasksResponse) Descriptor deprecated added in v0.6.0 

func (*ListTasksResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListTasksResponse.ProtoReflect.Descriptor instead.

func (*ListTasksResponse) GetNextPageToken added in v0.6.0 

func (x *ListTasksResponse) GetNextPageToken() string

func (*ListTasksResponse) GetTasks added in v0.6.0 

func (x *ListTasksResponse) GetTasks() []*Task

func (*ListTasksResponse) ProtoMessage added in v0.6.0 

func (*ListTasksResponse) ProtoMessage()

func (*ListTasksResponse) ProtoReflect added in v0.6.0 

func (x *ListTasksResponse) ProtoReflect() protoreflect.Message

func (*ListTasksResponse) Reset added in v0.6.0 

func (x *ListTasksResponse) Reset()

func (*ListTasksResponse) String added in v0.6.0 

func (x *ListTasksResponse) String() string

type Task 

type Task struct {
	Id          int64                  `protobuf:"varint,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"`
	Deadline    *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=deadline,proto3" json:"deadline,omitempty"`
	CompletedAt *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=completed_at,json=completedAt,proto3" json:"completed_at,omitempty"`
	CreateTime  *timestamppb.Timestamp `protobuf:"bytes,1000,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	UpdateTime  *timestamppb.Timestamp `protobuf:"bytes,1001,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

func (*Task) Descriptor deprecated 

func (*Task) Descriptor() ([]byte, []int)

Deprecated: Use Task.ProtoReflect.Descriptor instead.

func (*Task) GetCompletedAt 

func (x *Task) GetCompletedAt() *timestamppb.Timestamp

func (*Task) GetCreateTime 

func (x *Task) GetCreateTime() *timestamppb.Timestamp

func (*Task) GetDeadline 

func (x *Task) GetDeadline() *timestamppb.Timestamp

func (*Task) GetDescription 

func (x *Task) GetDescription() string

func (*Task) GetId 

func (x *Task) GetId() int64

func (*Task) GetTitle 

func (x *Task) GetTitle() string

func (*Task) GetUpdateTime 

func (x *Task) GetUpdateTime() *timestamppb.Timestamp

func (*Task) ProtoMessage 

func (*Task) ProtoMessage()

func (*Task) ProtoReflect 

func (x *Task) ProtoReflect() protoreflect.Message

func (*Task) Reset 

func (x *Task) Reset()

func (*Task) String 

func (x *Task) String() string

type TasksReaderServiceClient added in v0.5.0 

type TasksReaderServiceClient interface {
	// GetTask returns a Task.
	GetTask(ctx context.Context, in *GetTaskRequest, opts ...grpc.CallOption) (*Task, error)
	// ListTasks returns a list of Tasks.
	ListTasks(ctx context.Context, in *ListTasksRequest, opts ...grpc.CallOption) (*ListTasksResponse, error)
}

TasksReaderServiceClient is the client API for TasksReaderService 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 NewTasksReaderServiceClient added in v0.5.0 

func NewTasksReaderServiceClient(cc grpc.ClientConnInterface) TasksReaderServiceClient

type TasksReaderServiceServer added in v0.5.0 

type TasksReaderServiceServer interface {
	// GetTask returns a Task.
	GetTask(context.Context, *GetTaskRequest) (*Task, error)
	// ListTasks returns a list of Tasks.
	ListTasks(context.Context, *ListTasksRequest) (*ListTasksResponse, error)
	// contains filtered or unexported methods
}

TasksReaderServiceServer is the server API for TasksReaderService service. All implementations must embed UnimplementedTasksReaderServiceServer for forward compatibility

type TasksWriterServiceClient added in v0.5.0 

type TasksWriterServiceClient interface {
	// CreateTask creates a Task.
	CreateTask(ctx context.Context, in *CreateTaskRequest, opts ...grpc.CallOption) (*Task, error)
	DeleteTask(ctx context.Context, in *DeleteTaskRequest, opts ...grpc.CallOption) (*Task, error)
	UndeleteTask(ctx context.Context, in *UndeleteTaskRequest, opts ...grpc.CallOption) (*Task, error)
	UpdateTask(ctx context.Context, in *UpdateTaskRequest, opts ...grpc.CallOption) (*Task, error)
}

TasksWriterServiceClient is the client API for TasksWriterService 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 NewTasksWriterServiceClient added in v0.5.0 

func NewTasksWriterServiceClient(cc grpc.ClientConnInterface) TasksWriterServiceClient

type TasksWriterServiceServer added in v0.5.0 

type TasksWriterServiceServer interface {
	// CreateTask creates a Task.
	CreateTask(context.Context, *CreateTaskRequest) (*Task, error)
	DeleteTask(context.Context, *DeleteTaskRequest) (*Task, error)
	UndeleteTask(context.Context, *UndeleteTaskRequest) (*Task, error)
	UpdateTask(context.Context, *UpdateTaskRequest) (*Task, error)
	// contains filtered or unexported methods
}

TasksWriterServiceServer is the server API for TasksWriterService service. All implementations must embed UnimplementedTasksWriterServiceServer for forward compatibility

type UndeleteTaskRequest added in v0.6.0 

type UndeleteTaskRequest struct {
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*UndeleteTaskRequest) Descriptor deprecated added in v0.6.0 

func (*UndeleteTaskRequest) Descriptor() ([]byte, []int)

Deprecated: Use UndeleteTaskRequest.ProtoReflect.Descriptor instead.

func (*UndeleteTaskRequest) GetId added in v0.6.0 

func (x *UndeleteTaskRequest) GetId() int64

func (*UndeleteTaskRequest) ProtoMessage added in v0.6.0 

func (*UndeleteTaskRequest) ProtoMessage()

func (*UndeleteTaskRequest) ProtoReflect added in v0.6.0 

func (x *UndeleteTaskRequest) ProtoReflect() protoreflect.Message

func (*UndeleteTaskRequest) Reset added in v0.6.0 

func (x *UndeleteTaskRequest) Reset()

func (*UndeleteTaskRequest) String added in v0.6.0 

func (x *UndeleteTaskRequest) String() string

type UnimplementedTasksReaderServiceServer added in v0.5.0 

type UnimplementedTasksReaderServiceServer struct {
}

UnimplementedTasksReaderServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedTasksReaderServiceServer) GetTask added in v0.5.0 

func (UnimplementedTasksReaderServiceServer) GetTask(context.Context, *GetTaskRequest) (*Task, error)

func (UnimplementedTasksReaderServiceServer) ListTasks added in v0.6.0 

func (UnimplementedTasksReaderServiceServer) ListTasks(context.Context, *ListTasksRequest) (*ListTasksResponse, error)

type UnimplementedTasksWriterServiceServer added in v0.5.0 

type UnimplementedTasksWriterServiceServer struct {
}

UnimplementedTasksWriterServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedTasksWriterServiceServer) CreateTask added in v0.5.0 

func (UnimplementedTasksWriterServiceServer) CreateTask(context.Context, *CreateTaskRequest) (*Task, error)

func (UnimplementedTasksWriterServiceServer) DeleteTask added in v0.6.0 

func (UnimplementedTasksWriterServiceServer) DeleteTask(context.Context, *DeleteTaskRequest) (*Task, error)

func (UnimplementedTasksWriterServiceServer) UndeleteTask added in v0.6.0 

func (UnimplementedTasksWriterServiceServer) UndeleteTask(context.Context, *UndeleteTaskRequest) (*Task, error)

func (UnimplementedTasksWriterServiceServer) UpdateTask added in v0.6.0 

func (UnimplementedTasksWriterServiceServer) UpdateTask(context.Context, *UpdateTaskRequest) (*Task, error)

type UnsafeTasksReaderServiceServer added in v0.5.0 

type UnsafeTasksReaderServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeTasksReaderServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to TasksReaderServiceServer will result in compilation errors.

type UnsafeTasksWriterServiceServer added in v0.5.0 

type UnsafeTasksWriterServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeTasksWriterServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to TasksWriterServiceServer will result in compilation errors.

type UpdateTaskRequest added in v0.6.0 

type UpdateTaskRequest struct {
	Task       *Task                  `protobuf:"bytes,1,opt,name=task,proto3" json:"task,omitempty"`
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateTaskRequest) Descriptor deprecated added in v0.6.0 

func (*UpdateTaskRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateTaskRequest.ProtoReflect.Descriptor instead.

func (*UpdateTaskRequest) GetTask added in v0.6.0 

func (x *UpdateTaskRequest) GetTask() *Task

func (*UpdateTaskRequest) GetUpdateMask added in v0.6.0 

func (x *UpdateTaskRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateTaskRequest) ProtoMessage added in v0.6.0 

func (*UpdateTaskRequest) ProtoMessage()

func (*UpdateTaskRequest) ProtoReflect added in v0.6.0 

func (x *UpdateTaskRequest) ProtoReflect() protoreflect.Message

func (*UpdateTaskRequest) Reset added in v0.6.0 

func (x *UpdateTaskRequest) Reset()

func (*UpdateTaskRequest) String added in v0.6.0 

func (x *UpdateTaskRequest) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.