Documentation
¶
Overview ¶
Package v1 is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterTodoServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterTodoServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client TodoServiceClient) error
- func RegisterTodoServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterTodoServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server TodoServiceServer) error
- func RegisterTodoServiceServer(s grpc.ServiceRegistrar, srv TodoServiceServer)
- type CreateTodoRequest
- func (*CreateTodoRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CreateTodoRequest) GetPassword() string
- func (x *CreateTodoRequest) GetTodo() *v1alpha1.Todo
- func (*CreateTodoRequest) ProtoMessage()
- func (x *CreateTodoRequest) ProtoReflect() protoreflect.Message
- func (x *CreateTodoRequest) Reset()
- func (x *CreateTodoRequest) String() string
- type CreateTodoResponse
- type DeleteTodoRequest
- func (*DeleteTodoRequest) Descriptor() ([]byte, []int)deprecated
- func (x *DeleteTodoRequest) GetName() string
- func (x *DeleteTodoRequest) GetNamespace() string
- func (*DeleteTodoRequest) ProtoMessage()
- func (x *DeleteTodoRequest) ProtoReflect() protoreflect.Message
- func (x *DeleteTodoRequest) Reset()
- func (x *DeleteTodoRequest) String() string
- type DeleteTodoResponse
- type GetTodoRequest
- func (*GetTodoRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetTodoRequest) GetName() string
- func (x *GetTodoRequest) GetNamespace() string
- func (*GetTodoRequest) ProtoMessage()
- func (x *GetTodoRequest) ProtoReflect() protoreflect.Message
- func (x *GetTodoRequest) Reset()
- func (x *GetTodoRequest) String() string
- type GetTodoResponse
- func (*GetTodoResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetTodoResponse) GetTodo() *v1alpha1.Todo
- func (x *GetTodoResponse) GetYaml() string
- func (*GetTodoResponse) ProtoMessage()
- func (x *GetTodoResponse) ProtoReflect() protoreflect.Message
- func (x *GetTodoResponse) Reset()
- func (x *GetTodoResponse) String() string
- type ListTodosRequest
- func (*ListTodosRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListTodosRequest) GetLabels() map[string]string
- func (x *ListTodosRequest) GetNamespace() string
- func (*ListTodosRequest) ProtoMessage()
- func (x *ListTodosRequest) ProtoReflect() protoreflect.Message
- func (x *ListTodosRequest) Reset()
- func (x *ListTodosRequest) String() string
- type ListTodosResponse
- func (*ListTodosResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListTodosResponse) GetNextPageToken() string
- func (x *ListTodosResponse) GetTodos() *v1alpha1.TodoList
- func (*ListTodosResponse) ProtoMessage()
- func (x *ListTodosResponse) ProtoReflect() protoreflect.Message
- func (x *ListTodosResponse) Reset()
- func (x *ListTodosResponse) String() string
- type TodoServiceClient
- type TodoServiceServer
- type UnimplementedTodoServiceServer
- func (UnimplementedTodoServiceServer) CreateTodo(context.Context, *CreateTodoRequest) (*CreateTodoResponse, error)
- func (UnimplementedTodoServiceServer) DeleteTodo(context.Context, *DeleteTodoRequest) (*DeleteTodoResponse, error)
- func (UnimplementedTodoServiceServer) GetTodo(context.Context, *GetTodoRequest) (*GetTodoResponse, error)
- func (UnimplementedTodoServiceServer) ListTodos(context.Context, *ListTodosRequest) (*ListTodosResponse, error)
- func (UnimplementedTodoServiceServer) UpdateTodo(context.Context, *UpdateTodoRequest) (*UpdateTodoResponse, error)
- type UnsafeTodoServiceServer
- type UpdateTodoRequest
- func (*UpdateTodoRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UpdateTodoRequest) GetFieldMask() *field_mask.FieldMask
- func (x *UpdateTodoRequest) GetTodo() *v1alpha1.Todo
- func (*UpdateTodoRequest) ProtoMessage()
- func (x *UpdateTodoRequest) ProtoReflect() protoreflect.Message
- func (x *UpdateTodoRequest) Reset()
- func (x *UpdateTodoRequest) String() string
- type UpdateTodoResponse
Constants ¶
This section is empty.
Variables ¶
var File_github_com_metaprov_modelaapi_services_todo_v1_todo_proto protoreflect.FileDescriptor
var TodoService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "github.com.metaprov.modelaapi.services.todo.v1.TodoService", HandlerType: (*TodoServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "ListTodos", Handler: _TodoService_ListTodos_Handler, }, { MethodName: "CreateTodo", Handler: _TodoService_CreateTodo_Handler, }, { MethodName: "GetTodo", Handler: _TodoService_GetTodo_Handler, }, { MethodName: "UpdateTodo", Handler: _TodoService_UpdateTodo_Handler, }, { MethodName: "DeleteTodo", Handler: _TodoService_DeleteTodo_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "github.com/metaprov/modelaapi/services/todo/v1/todo.proto", }
TodoService_ServiceDesc is the grpc.ServiceDesc for TodoService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterTodoServiceHandler ¶ added in v0.4.687
func RegisterTodoServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterTodoServiceHandler registers the http handlers for service TodoService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterTodoServiceHandlerClient ¶ added in v0.4.687
func RegisterTodoServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client TodoServiceClient) error
RegisterTodoServiceHandlerClient registers the http handlers for service TodoService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "TodoServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "TodoServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "TodoServiceClient" to call the correct interceptors.
func RegisterTodoServiceHandlerFromEndpoint ¶ added in v0.4.687
func RegisterTodoServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterTodoServiceHandlerFromEndpoint is same as RegisterTodoServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterTodoServiceHandlerServer ¶ added in v0.4.687
func RegisterTodoServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server TodoServiceServer) error
RegisterTodoServiceHandlerServer registers the http handlers for service TodoService to "mux". UnaryRPC :call TodoServiceServer 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 RegisterTodoServiceHandlerFromEndpoint instead.
func RegisterTodoServiceServer ¶
func RegisterTodoServiceServer(s grpc.ServiceRegistrar, srv TodoServiceServer)
Types ¶
type CreateTodoRequest ¶
type CreateTodoRequest struct { Todo *v1alpha1.Todo `protobuf:"bytes,1,opt,name=todo,proto3" json:"todo,omitempty"` Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"` // contains filtered or unexported fields }
func (*CreateTodoRequest) Descriptor
deprecated
func (*CreateTodoRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateTodoRequest.ProtoReflect.Descriptor instead.
func (*CreateTodoRequest) GetPassword ¶
func (x *CreateTodoRequest) GetPassword() string
func (*CreateTodoRequest) GetTodo ¶ added in v0.4.472
func (x *CreateTodoRequest) GetTodo() *v1alpha1.Todo
func (*CreateTodoRequest) ProtoMessage ¶
func (*CreateTodoRequest) ProtoMessage()
func (*CreateTodoRequest) ProtoReflect ¶
func (x *CreateTodoRequest) ProtoReflect() protoreflect.Message
func (*CreateTodoRequest) Reset ¶
func (x *CreateTodoRequest) Reset()
func (*CreateTodoRequest) String ¶
func (x *CreateTodoRequest) String() string
type CreateTodoResponse ¶
type CreateTodoResponse struct {
// contains filtered or unexported fields
}
func (*CreateTodoResponse) Descriptor
deprecated
func (*CreateTodoResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateTodoResponse.ProtoReflect.Descriptor instead.
func (*CreateTodoResponse) ProtoMessage ¶
func (*CreateTodoResponse) ProtoMessage()
func (*CreateTodoResponse) ProtoReflect ¶
func (x *CreateTodoResponse) ProtoReflect() protoreflect.Message
func (*CreateTodoResponse) Reset ¶
func (x *CreateTodoResponse) Reset()
func (*CreateTodoResponse) String ¶
func (x *CreateTodoResponse) String() string
type DeleteTodoRequest ¶
type DeleteTodoRequest struct { Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"` Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
func (*DeleteTodoRequest) Descriptor
deprecated
func (*DeleteTodoRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteTodoRequest.ProtoReflect.Descriptor instead.
func (*DeleteTodoRequest) GetName ¶
func (x *DeleteTodoRequest) GetName() string
func (*DeleteTodoRequest) GetNamespace ¶
func (x *DeleteTodoRequest) GetNamespace() string
func (*DeleteTodoRequest) ProtoMessage ¶
func (*DeleteTodoRequest) ProtoMessage()
func (*DeleteTodoRequest) ProtoReflect ¶
func (x *DeleteTodoRequest) ProtoReflect() protoreflect.Message
func (*DeleteTodoRequest) Reset ¶
func (x *DeleteTodoRequest) Reset()
func (*DeleteTodoRequest) String ¶
func (x *DeleteTodoRequest) String() string
type DeleteTodoResponse ¶
type DeleteTodoResponse struct {
// contains filtered or unexported fields
}
func (*DeleteTodoResponse) Descriptor
deprecated
func (*DeleteTodoResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeleteTodoResponse.ProtoReflect.Descriptor instead.
func (*DeleteTodoResponse) ProtoMessage ¶
func (*DeleteTodoResponse) ProtoMessage()
func (*DeleteTodoResponse) ProtoReflect ¶
func (x *DeleteTodoResponse) ProtoReflect() protoreflect.Message
func (*DeleteTodoResponse) Reset ¶
func (x *DeleteTodoResponse) Reset()
func (*DeleteTodoResponse) String ¶
func (x *DeleteTodoResponse) String() string
type GetTodoRequest ¶
type GetTodoRequest struct { Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"` Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
func (*GetTodoRequest) Descriptor
deprecated
func (*GetTodoRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetTodoRequest.ProtoReflect.Descriptor instead.
func (*GetTodoRequest) GetName ¶
func (x *GetTodoRequest) GetName() string
func (*GetTodoRequest) GetNamespace ¶
func (x *GetTodoRequest) GetNamespace() string
func (*GetTodoRequest) ProtoMessage ¶
func (*GetTodoRequest) ProtoMessage()
func (*GetTodoRequest) ProtoReflect ¶
func (x *GetTodoRequest) ProtoReflect() protoreflect.Message
func (*GetTodoRequest) Reset ¶
func (x *GetTodoRequest) Reset()
func (*GetTodoRequest) String ¶
func (x *GetTodoRequest) String() string
type GetTodoResponse ¶
type GetTodoResponse struct { Todo *v1alpha1.Todo `protobuf:"bytes,1,opt,name=todo,proto3" json:"todo,omitempty"` Yaml string `protobuf:"bytes,2,opt,name=yaml,proto3" json:"yaml,omitempty"` // contains filtered or unexported fields }
func (*GetTodoResponse) Descriptor
deprecated
func (*GetTodoResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetTodoResponse.ProtoReflect.Descriptor instead.
func (*GetTodoResponse) GetTodo ¶ added in v0.4.472
func (x *GetTodoResponse) GetTodo() *v1alpha1.Todo
func (*GetTodoResponse) GetYaml ¶
func (x *GetTodoResponse) GetYaml() string
func (*GetTodoResponse) ProtoMessage ¶
func (*GetTodoResponse) ProtoMessage()
func (*GetTodoResponse) ProtoReflect ¶
func (x *GetTodoResponse) ProtoReflect() protoreflect.Message
func (*GetTodoResponse) Reset ¶
func (x *GetTodoResponse) Reset()
func (*GetTodoResponse) String ¶
func (x *GetTodoResponse) String() string
type ListTodosRequest ¶
type ListTodosRequest struct { Namespace string `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"` Labels map[string]string `` /* 153-byte string literal not displayed */ // contains filtered or unexported fields }
func (*ListTodosRequest) Descriptor
deprecated
func (*ListTodosRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListTodosRequest.ProtoReflect.Descriptor instead.
func (*ListTodosRequest) GetLabels ¶
func (x *ListTodosRequest) GetLabels() map[string]string
func (*ListTodosRequest) GetNamespace ¶
func (x *ListTodosRequest) GetNamespace() string
func (*ListTodosRequest) ProtoMessage ¶
func (*ListTodosRequest) ProtoMessage()
func (*ListTodosRequest) ProtoReflect ¶
func (x *ListTodosRequest) ProtoReflect() protoreflect.Message
func (*ListTodosRequest) Reset ¶
func (x *ListTodosRequest) Reset()
func (*ListTodosRequest) String ¶
func (x *ListTodosRequest) String() string
type ListTodosResponse ¶
type ListTodosResponse struct { Todos *v1alpha1.TodoList `protobuf:"bytes,1,opt,name=todos,proto3" json:"todos,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 (*ListTodosResponse) Descriptor
deprecated
func (*ListTodosResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListTodosResponse.ProtoReflect.Descriptor instead.
func (*ListTodosResponse) GetNextPageToken ¶ added in v0.4.472
func (x *ListTodosResponse) GetNextPageToken() string
func (*ListTodosResponse) GetTodos ¶ added in v0.4.472
func (x *ListTodosResponse) GetTodos() *v1alpha1.TodoList
func (*ListTodosResponse) ProtoMessage ¶
func (*ListTodosResponse) ProtoMessage()
func (*ListTodosResponse) ProtoReflect ¶
func (x *ListTodosResponse) ProtoReflect() protoreflect.Message
func (*ListTodosResponse) Reset ¶
func (x *ListTodosResponse) Reset()
func (*ListTodosResponse) String ¶
func (x *ListTodosResponse) String() string
type TodoServiceClient ¶
type TodoServiceClient interface { ListTodos(ctx context.Context, in *ListTodosRequest, opts ...grpc.CallOption) (*ListTodosResponse, error) CreateTodo(ctx context.Context, in *CreateTodoRequest, opts ...grpc.CallOption) (*CreateTodoResponse, error) GetTodo(ctx context.Context, in *GetTodoRequest, opts ...grpc.CallOption) (*GetTodoResponse, error) UpdateTodo(ctx context.Context, in *UpdateTodoRequest, opts ...grpc.CallOption) (*UpdateTodoResponse, error) DeleteTodo(ctx context.Context, in *DeleteTodoRequest, opts ...grpc.CallOption) (*DeleteTodoResponse, error) }
TodoServiceClient is the client API for TodoService 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 NewTodoServiceClient ¶
func NewTodoServiceClient(cc grpc.ClientConnInterface) TodoServiceClient
type TodoServiceServer ¶
type TodoServiceServer interface { ListTodos(context.Context, *ListTodosRequest) (*ListTodosResponse, error) CreateTodo(context.Context, *CreateTodoRequest) (*CreateTodoResponse, error) GetTodo(context.Context, *GetTodoRequest) (*GetTodoResponse, error) UpdateTodo(context.Context, *UpdateTodoRequest) (*UpdateTodoResponse, error) DeleteTodo(context.Context, *DeleteTodoRequest) (*DeleteTodoResponse, error) // contains filtered or unexported methods }
TodoServiceServer is the server API for TodoService service. All implementations must embed UnimplementedTodoServiceServer for forward compatibility
type UnimplementedTodoServiceServer ¶
type UnimplementedTodoServiceServer struct { }
UnimplementedTodoServiceServer must be embedded to have forward compatible implementations.
func (UnimplementedTodoServiceServer) CreateTodo ¶
func (UnimplementedTodoServiceServer) CreateTodo(context.Context, *CreateTodoRequest) (*CreateTodoResponse, error)
func (UnimplementedTodoServiceServer) DeleteTodo ¶
func (UnimplementedTodoServiceServer) DeleteTodo(context.Context, *DeleteTodoRequest) (*DeleteTodoResponse, error)
func (UnimplementedTodoServiceServer) GetTodo ¶
func (UnimplementedTodoServiceServer) GetTodo(context.Context, *GetTodoRequest) (*GetTodoResponse, error)
func (UnimplementedTodoServiceServer) ListTodos ¶
func (UnimplementedTodoServiceServer) ListTodos(context.Context, *ListTodosRequest) (*ListTodosResponse, error)
func (UnimplementedTodoServiceServer) UpdateTodo ¶
func (UnimplementedTodoServiceServer) UpdateTodo(context.Context, *UpdateTodoRequest) (*UpdateTodoResponse, error)
type UnsafeTodoServiceServer ¶ added in v0.4.687
type UnsafeTodoServiceServer interface {
// contains filtered or unexported methods
}
UnsafeTodoServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to TodoServiceServer will result in compilation errors.
type UpdateTodoRequest ¶
type UpdateTodoRequest struct { Todo *v1alpha1.Todo `protobuf:"bytes,1,opt,name=todo,proto3" json:"todo,omitempty"` FieldMask *field_mask.FieldMask `protobuf:"bytes,2,opt,name=field_mask,json=fieldMask,proto3" json:"field_mask,omitempty"` // contains filtered or unexported fields }
func (*UpdateTodoRequest) Descriptor
deprecated
func (*UpdateTodoRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateTodoRequest.ProtoReflect.Descriptor instead.
func (*UpdateTodoRequest) GetFieldMask ¶ added in v0.4.422
func (x *UpdateTodoRequest) GetFieldMask() *field_mask.FieldMask
func (*UpdateTodoRequest) GetTodo ¶ added in v0.4.475
func (x *UpdateTodoRequest) GetTodo() *v1alpha1.Todo
func (*UpdateTodoRequest) ProtoMessage ¶
func (*UpdateTodoRequest) ProtoMessage()
func (*UpdateTodoRequest) ProtoReflect ¶
func (x *UpdateTodoRequest) ProtoReflect() protoreflect.Message
func (*UpdateTodoRequest) Reset ¶
func (x *UpdateTodoRequest) Reset()
func (*UpdateTodoRequest) String ¶
func (x *UpdateTodoRequest) String() string
type UpdateTodoResponse ¶
type UpdateTodoResponse struct {
// contains filtered or unexported fields
}
func (*UpdateTodoResponse) Descriptor
deprecated
func (*UpdateTodoResponse) Descriptor() ([]byte, []int)
Deprecated: Use UpdateTodoResponse.ProtoReflect.Descriptor instead.
func (*UpdateTodoResponse) ProtoMessage ¶
func (*UpdateTodoResponse) ProtoMessage()
func (*UpdateTodoResponse) ProtoReflect ¶
func (x *UpdateTodoResponse) ProtoReflect() protoreflect.Message
func (*UpdateTodoResponse) Reset ¶
func (x *UpdateTodoResponse) Reset()
func (*UpdateTodoResponse) String ¶
func (x *UpdateTodoResponse) String() string