saved

package
v0.0.0-...-a0d1ad3 Latest Latest
Warning

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

 Go to latest Published: Nov 25, 2022 License: MIT Imports: 17 Imported by: 0

Documentation

Overview

Package saved is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source 
var File_proto_v1alpha1_saved_saved_proto protoreflect.FileDescriptor
View Source 
var Saved_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "hvx.api.v1alpha1.saved.proto.Saved",
	HandlerType: (*SavedServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Create",
			Handler:    _Saved_Create_Handler,
		},
		{
			MethodName: "GetSaved",
			Handler:    _Saved_GetSaved_Handler,
		},
		{
			MethodName: "GetSaves",
			Handler:    _Saved_GetSaves_Handler,
		},
		{
			MethodName: "EditSaved",
			Handler:    _Saved_EditSaved_Handler,
		},
		{
			MethodName: "Delete",
			Handler:    _Saved_Delete_Handler,
		},
		{
			MethodName: "DeleteSaves",
			Handler:    _Saved_DeleteSaves_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "proto/v1alpha1/saved/saved.proto",
}

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

Functions

func RegisterSavedHandler 

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

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

func RegisterSavedHandlerClient 

func RegisterSavedHandlerClient(ctx context.Context, mux *runtime.ServeMux, client SavedClient) error

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

func RegisterSavedHandlerFromEndpoint 

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

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

func RegisterSavedHandlerServer 

func RegisterSavedHandlerServer(ctx context.Context, mux *runtime.ServeMux, server SavedServer) error

RegisterSavedHandlerServer registers the http handlers for service Saved to "mux". UnaryRPC :call SavedServer 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 RegisterSavedHandlerFromEndpoint instead.

func RegisterSavedServer 

func RegisterSavedServer(s grpc.ServiceRegistrar, srv SavedServer)

Types

type CreateRequest 

type CreateRequest struct {
	Files []*Files `protobuf:"bytes,1,rep,name=files,proto3" json:"files,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateRequest) Descriptor deprecated 

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

Deprecated: Use CreateRequest.ProtoReflect.Descriptor instead.

func (*CreateRequest) GetFiles 

func (x *CreateRequest) GetFiles() []*Files

func (*CreateRequest) ProtoMessage 

func (*CreateRequest) ProtoMessage()

func (*CreateRequest) ProtoReflect 

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

func (*CreateRequest) Reset 

func (x *CreateRequest) Reset()

func (*CreateRequest) String 

func (x *CreateRequest) String() string

type CreateResponse 

type CreateResponse struct {
	Code   string `protobuf:"bytes,1,opt,name=code,proto3" json:"code,omitempty"`
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateResponse) Descriptor deprecated 

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

Deprecated: Use CreateResponse.ProtoReflect.Descriptor instead.

func (*CreateResponse) GetCode 

func (x *CreateResponse) GetCode() string

func (*CreateResponse) GetStatus 

func (x *CreateResponse) GetStatus() string

func (*CreateResponse) ProtoMessage 

func (*CreateResponse) ProtoMessage()

func (*CreateResponse) ProtoReflect 

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

func (*CreateResponse) Reset 

func (x *CreateResponse) Reset()

func (*CreateResponse) String 

func (x *CreateResponse) String() string

type DeleteRequest 

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

func (*DeleteRequest) Descriptor deprecated 

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

Deprecated: Use DeleteRequest.ProtoReflect.Descriptor instead.

func (*DeleteRequest) GetId 

func (x *DeleteRequest) GetId() int64

func (*DeleteRequest) ProtoMessage 

func (*DeleteRequest) ProtoMessage()

func (*DeleteRequest) ProtoReflect 

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

func (*DeleteRequest) Reset 

func (x *DeleteRequest) Reset()

func (*DeleteRequest) String 

func (x *DeleteRequest) String() string

type DeleteResponse 

type DeleteResponse struct {
	Code   string `protobuf:"bytes,1,opt,name=code,proto3" json:"code,omitempty"`
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteResponse) Descriptor deprecated 

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

Deprecated: Use DeleteResponse.ProtoReflect.Descriptor instead.

func (*DeleteResponse) GetCode 

func (x *DeleteResponse) GetCode() string

func (*DeleteResponse) GetStatus 

func (x *DeleteResponse) GetStatus() string

func (*DeleteResponse) ProtoMessage 

func (*DeleteResponse) ProtoMessage()

func (*DeleteResponse) ProtoReflect 

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

func (*DeleteResponse) Reset 

func (x *DeleteResponse) Reset()

func (*DeleteResponse) String 

func (x *DeleteResponse) String() string

type DeleteSavesRequest 

type DeleteSavesRequest struct {
	Password string `protobuf:"bytes,1,opt,name=password,proto3" json:"password,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteSavesRequest) Descriptor deprecated 

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

Deprecated: Use DeleteSavesRequest.ProtoReflect.Descriptor instead.

func (*DeleteSavesRequest) GetPassword 

func (x *DeleteSavesRequest) GetPassword() string

func (*DeleteSavesRequest) ProtoMessage 

func (*DeleteSavesRequest) ProtoMessage()

func (*DeleteSavesRequest) ProtoReflect 

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

func (*DeleteSavesRequest) Reset 

func (x *DeleteSavesRequest) Reset()

func (*DeleteSavesRequest) String 

func (x *DeleteSavesRequest) String() string

type DeleteSavesResponse 

type DeleteSavesResponse struct {
	Code   string `protobuf:"bytes,1,opt,name=code,proto3" json:"code,omitempty"`
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteSavesResponse) Descriptor deprecated 

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

Deprecated: Use DeleteSavesResponse.ProtoReflect.Descriptor instead.

func (*DeleteSavesResponse) GetCode 

func (x *DeleteSavesResponse) GetCode() string

func (*DeleteSavesResponse) GetStatus 

func (x *DeleteSavesResponse) GetStatus() string

func (*DeleteSavesResponse) ProtoMessage 

func (*DeleteSavesResponse) ProtoMessage()

func (*DeleteSavesResponse) ProtoReflect 

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

func (*DeleteSavesResponse) Reset 

func (x *DeleteSavesResponse) Reset()

func (*DeleteSavesResponse) String 

func (x *DeleteSavesResponse) String() string

type EditSavedRequest 

type EditSavedRequest struct {
	Id      int64  `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	Name    string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	Comment string `protobuf:"bytes,4,opt,name=comment,proto3" json:"comment,omitempty"`
	// contains filtered or unexported fields
}

func (*EditSavedRequest) Descriptor deprecated 

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

Deprecated: Use EditSavedRequest.ProtoReflect.Descriptor instead.

func (*EditSavedRequest) GetComment 

func (x *EditSavedRequest) GetComment() string

func (*EditSavedRequest) GetId 

func (x *EditSavedRequest) GetId() int64

func (*EditSavedRequest) GetName 

func (x *EditSavedRequest) GetName() string

func (*EditSavedRequest) ProtoMessage 

func (*EditSavedRequest) ProtoMessage()

func (*EditSavedRequest) ProtoReflect 

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

func (*EditSavedRequest) Reset 

func (x *EditSavedRequest) Reset()

func (*EditSavedRequest) String 

func (x *EditSavedRequest) String() string

type EditSavedResponse 

type EditSavedResponse struct {
	Code   string `protobuf:"bytes,1,opt,name=code,proto3" json:"code,omitempty"`
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*EditSavedResponse) Descriptor deprecated 

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

Deprecated: Use EditSavedResponse.ProtoReflect.Descriptor instead.

func (*EditSavedResponse) GetCode 

func (x *EditSavedResponse) GetCode() string

func (*EditSavedResponse) GetStatus 

func (x *EditSavedResponse) GetStatus() string

func (*EditSavedResponse) ProtoMessage 

func (*EditSavedResponse) ProtoMessage()

func (*EditSavedResponse) ProtoReflect 

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

func (*EditSavedResponse) Reset 

func (x *EditSavedResponse) Reset()

func (*EditSavedResponse) String 

func (x *EditSavedResponse) String() string

type Files 

type Files struct {
	Name      string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Type      string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	Cid       string `protobuf:"bytes,3,opt,name=cid,proto3" json:"cid,omitempty"`
	Comment   string `protobuf:"bytes,4,opt,name=comment,proto3" json:"comment,omitempty"`
	IsPrivate bool   `protobuf:"varint,5,opt,name=isPrivate,proto3" json:"isPrivate,omitempty"`
	// contains filtered or unexported fields
}

func (*Files) Descriptor deprecated 

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

Deprecated: Use Files.ProtoReflect.Descriptor instead.

func (*Files) GetCid 

func (x *Files) GetCid() string

func (*Files) GetComment 

func (x *Files) GetComment() string

func (*Files) GetIsPrivate 

func (x *Files) GetIsPrivate() bool

func (*Files) GetName 

func (x *Files) GetName() string

func (*Files) GetType 

func (x *Files) GetType() string

func (*Files) ProtoMessage 

func (*Files) ProtoMessage()

func (*Files) ProtoReflect 

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

func (*Files) Reset 

func (x *Files) Reset()

func (*Files) String 

func (x *Files) String() string

type GetSavedRequest 

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

func (*GetSavedRequest) Descriptor deprecated 

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

Deprecated: Use GetSavedRequest.ProtoReflect.Descriptor instead.

func (*GetSavedRequest) GetId 

func (x *GetSavedRequest) GetId() string

func (*GetSavedRequest) ProtoMessage 

func (*GetSavedRequest) ProtoMessage()

func (*GetSavedRequest) ProtoReflect 

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

func (*GetSavedRequest) Reset 

func (x *GetSavedRequest) Reset()

func (*GetSavedRequest) String 

func (x *GetSavedRequest) String() string

type GetSavesResponse 

type GetSavesResponse struct {
	Code  string  `protobuf:"bytes,1,opt,name=code,proto3" json:"code,omitempty"`
	Saves []*Save `protobuf:"bytes,3,rep,name=saves,proto3" json:"saves,omitempty"`
	// contains filtered or unexported fields
}

func (*GetSavesResponse) Descriptor deprecated 

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

Deprecated: Use GetSavesResponse.ProtoReflect.Descriptor instead.

func (*GetSavesResponse) GetCode 

func (x *GetSavesResponse) GetCode() string

func (*GetSavesResponse) GetSaves 

func (x *GetSavesResponse) GetSaves() []*Save

func (*GetSavesResponse) ProtoMessage 

func (*GetSavesResponse) ProtoMessage()

func (*GetSavesResponse) ProtoReflect 

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

func (*GetSavesResponse) Reset 

func (x *GetSavesResponse) Reset()

func (*GetSavesResponse) String 

func (x *GetSavesResponse) String() string

type Save 

type Save struct {
	Id        int64  `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	Name      string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	Comment   string `protobuf:"bytes,4,opt,name=comment,proto3" json:"comment,omitempty"`
	Cid       string `protobuf:"bytes,5,opt,name=cid,proto3" json:"cid,omitempty"`
	Types     string `protobuf:"bytes,6,opt,name=types,proto3" json:"types,omitempty"`
	CreatedAt string `protobuf:"bytes,7,opt,name=createdAt,proto3" json:"createdAt,omitempty"`
	// contains filtered or unexported fields
}

func (*Save) Descriptor deprecated 

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

Deprecated: Use Save.ProtoReflect.Descriptor instead.

func (*Save) GetCid 

func (x *Save) GetCid() string

func (*Save) GetComment 

func (x *Save) GetComment() string

func (*Save) GetCreatedAt 

func (x *Save) GetCreatedAt() string

func (*Save) GetId 

func (x *Save) GetId() int64

func (*Save) GetName 

func (x *Save) GetName() string

func (*Save) GetTypes 

func (x *Save) GetTypes() string

func (*Save) ProtoMessage 

func (*Save) ProtoMessage()

func (*Save) ProtoReflect 

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

func (*Save) Reset 

func (x *Save) Reset()

func (*Save) String 

func (x *Save) String() string

type SavedClient 

type SavedClient interface {
	// Create Save the hash of the uploaded file to the database,
	// Because the file needs to be encrypted for the user to
	// choose, the upload to the IPFS file server should be
	// done in the client and the returned ipfs cid should be
	// submitted to the server, which will save it.
	Create(ctx context.Context, in *CreateRequest, opts ...grpc.CallOption) (*CreateResponse, error)
	GetSaved(ctx context.Context, in *GetSavedRequest, opts ...grpc.CallOption) (*Save, error)
	GetSaves(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*GetSavesResponse, error)
	// EditSaved Edit by saved ID.
	// View the EditSavedRequest relevant parameters that are allowed
	// to be changed.
	EditSaved(ctx context.Context, in *EditSavedRequest, opts ...grpc.CallOption) (*EditSavedResponse, error)
	// Delete by saved ID.
	// Users must be informed that data that exists in IPFS files
	// is not actually deleted, and user-friendly prompts need
	// to be returned.
	Delete(ctx context.Context, in *DeleteRequest, opts ...grpc.CallOption) (*DeleteResponse, error)
	// DeleteSaves This API is typically used when deleting an account.
	// When a user's account is completely deleted, no data should remain.
	DeleteSaves(ctx context.Context, in *DeleteSavesRequest, opts ...grpc.CallOption) (*DeleteSavesResponse, error)
}

SavedClient is the client API for Saved 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 NewSavedClient 

func NewSavedClient(cc grpc.ClientConnInterface) SavedClient

type SavedServer 

type SavedServer interface {
	// Create Save the hash of the uploaded file to the database,
	// Because the file needs to be encrypted for the user to
	// choose, the upload to the IPFS file server should be
	// done in the client and the returned ipfs cid should be
	// submitted to the server, which will save it.
	Create(context.Context, *CreateRequest) (*CreateResponse, error)
	GetSaved(context.Context, *GetSavedRequest) (*Save, error)
	GetSaves(context.Context, *emptypb.Empty) (*GetSavesResponse, error)
	// EditSaved Edit by saved ID.
	// View the EditSavedRequest relevant parameters that are allowed
	// to be changed.
	EditSaved(context.Context, *EditSavedRequest) (*EditSavedResponse, error)
	// Delete by saved ID.
	// Users must be informed that data that exists in IPFS files
	// is not actually deleted, and user-friendly prompts need
	// to be returned.
	Delete(context.Context, *DeleteRequest) (*DeleteResponse, error)
	// DeleteSaves This API is typically used when deleting an account.
	// When a user's account is completely deleted, no data should remain.
	DeleteSaves(context.Context, *DeleteSavesRequest) (*DeleteSavesResponse, error)
}

SavedServer is the server API for Saved service. All implementations should embed UnimplementedSavedServer for forward compatibility

type UnimplementedSavedServer 

type UnimplementedSavedServer struct {
}

UnimplementedSavedServer should be embedded to have forward compatible implementations.

func (UnimplementedSavedServer) Create 

func (UnimplementedSavedServer) Create(context.Context, *CreateRequest) (*CreateResponse, error)

func (UnimplementedSavedServer) Delete 

func (UnimplementedSavedServer) Delete(context.Context, *DeleteRequest) (*DeleteResponse, error)

func (UnimplementedSavedServer) DeleteSaves 

func (UnimplementedSavedServer) DeleteSaves(context.Context, *DeleteSavesRequest) (*DeleteSavesResponse, error)

func (UnimplementedSavedServer) EditSaved 

func (UnimplementedSavedServer) EditSaved(context.Context, *EditSavedRequest) (*EditSavedResponse, error)

func (UnimplementedSavedServer) GetSaved 

func (UnimplementedSavedServer) GetSaved(context.Context, *GetSavedRequest) (*Save, error)

func (UnimplementedSavedServer) GetSaves 

func (UnimplementedSavedServer) GetSaves(context.Context, *emptypb.Empty) (*GetSavesResponse, error)

type UnsafeSavedServer 

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

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

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.