collection

package
v0.0.0-...-953e6da Latest Latest
Warning

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

 Go to latest Published: Mar 26, 2024 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Overview

Package collection is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	CollectionService_CreateCollection_FullMethodName     = "/knowdateapp.knowledge.v1.collection.CollectionService/CreateCollection"
	CollectionService_GetCollectionById_FullMethodName    = "/knowdateapp.knowledge.v1.collection.CollectionService/GetCollectionById"
	CollectionService_DeleteCollectionById_FullMethodName = "/knowdateapp.knowledge.v1.collection.CollectionService/DeleteCollectionById"
)

Variables

View Source 
var CollectionService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "knowdateapp.knowledge.v1.collection.CollectionService",
	HandlerType: (*CollectionServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateCollection",
			Handler:    _CollectionService_CreateCollection_Handler,
		},
		{
			MethodName: "GetCollectionById",
			Handler:    _CollectionService_GetCollectionById_Handler,
		},
		{
			MethodName: "DeleteCollectionById",
			Handler:    _CollectionService_DeleteCollectionById_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "api/v1/collection/collection.proto",
}

CollectionService_ServiceDesc is the grpc.ServiceDesc for CollectionService 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 File_api_v1_collection_collection_proto protoreflect.FileDescriptor

Functions

func RegisterCollectionServiceHandler 

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

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

func RegisterCollectionServiceHandlerClient 

func RegisterCollectionServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client CollectionServiceClient) error

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

func RegisterCollectionServiceHandlerFromEndpoint 

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

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

func RegisterCollectionServiceHandlerServer 

func RegisterCollectionServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server CollectionServiceServer) error

RegisterCollectionServiceHandlerServer registers the http handlers for service CollectionService to "mux". UnaryRPC :call CollectionServiceServer 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 RegisterCollectionServiceHandlerFromEndpoint instead.

func RegisterCollectionServiceServer 

func RegisterCollectionServiceServer(s grpc.ServiceRegistrar, srv CollectionServiceServer)

Types

type CollectionServiceClient 

type CollectionServiceClient interface {
	CreateCollection(ctx context.Context, in *CreateCollectionRequest, opts ...grpc.CallOption) (*CreateCollectionResponse, error)
	GetCollectionById(ctx context.Context, in *GetCollectionByIdRequest, opts ...grpc.CallOption) (*GetCollectionByIdResponse, error)
	DeleteCollectionById(ctx context.Context, in *DeleteCollectionByIdRequest, opts ...grpc.CallOption) (*DeleteCollectionByIdResponse, error)
}

CollectionServiceClient is the client API for CollectionService 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 NewCollectionServiceClient 

func NewCollectionServiceClient(cc grpc.ClientConnInterface) CollectionServiceClient

type CollectionServiceServer 

type CollectionServiceServer interface {
	CreateCollection(context.Context, *CreateCollectionRequest) (*CreateCollectionResponse, error)
	GetCollectionById(context.Context, *GetCollectionByIdRequest) (*GetCollectionByIdResponse, error)
	DeleteCollectionById(context.Context, *DeleteCollectionByIdRequest) (*DeleteCollectionByIdResponse, error)
	// contains filtered or unexported methods
}

CollectionServiceServer is the server API for CollectionService service. All implementations must embed UnimplementedCollectionServiceServer for forward compatibility

type CreateCollectionRequest 

type CreateCollectionRequest struct {
	KnowledgeBaseId string `protobuf:"bytes,1,opt,name=knowledge_base_id,json=knowledgeBaseId,proto3" json:"knowledge_base_id,omitempty"`
	OwnerId         string `protobuf:"bytes,2,opt,name=owner_id,json=ownerId,proto3" json:"owner_id,omitempty"`
	Topic           string `protobuf:"bytes,3,opt,name=topic,proto3" json:"topic,omitempty"`
	Description     string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateCollectionRequest) Descriptor deprecated 

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

Deprecated: Use CreateCollectionRequest.ProtoReflect.Descriptor instead.

func (*CreateCollectionRequest) GetDescription 

func (x *CreateCollectionRequest) GetDescription() string

func (*CreateCollectionRequest) GetKnowledgeBaseId 

func (x *CreateCollectionRequest) GetKnowledgeBaseId() string

func (*CreateCollectionRequest) GetOwnerId 

func (x *CreateCollectionRequest) GetOwnerId() string

func (*CreateCollectionRequest) GetTopic 

func (x *CreateCollectionRequest) GetTopic() string

func (*CreateCollectionRequest) ProtoMessage 

func (*CreateCollectionRequest) ProtoMessage()

func (*CreateCollectionRequest) ProtoReflect 

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

func (*CreateCollectionRequest) Reset 

func (x *CreateCollectionRequest) Reset()

func (*CreateCollectionRequest) String 

func (x *CreateCollectionRequest) String() string

type CreateCollectionResponse 

type CreateCollectionResponse struct {
	Collection *common.Collection `protobuf:"bytes,1,opt,name=collection,proto3" json:"collection,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateCollectionResponse) Descriptor deprecated 

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

Deprecated: Use CreateCollectionResponse.ProtoReflect.Descriptor instead.

func (*CreateCollectionResponse) GetCollection 

func (x *CreateCollectionResponse) GetCollection() *common.Collection

func (*CreateCollectionResponse) ProtoMessage 

func (*CreateCollectionResponse) ProtoMessage()

func (*CreateCollectionResponse) ProtoReflect 

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

func (*CreateCollectionResponse) Reset 

func (x *CreateCollectionResponse) Reset()

func (*CreateCollectionResponse) String 

func (x *CreateCollectionResponse) String() string

type DeleteCollectionByIdRequest 

type DeleteCollectionByIdRequest struct {
	KnowledgeBaseId string `protobuf:"bytes,1,opt,name=knowledge_base_id,json=knowledgeBaseId,proto3" json:"knowledge_base_id,omitempty"`
	CollectionId    string `protobuf:"bytes,2,opt,name=collection_id,json=collectionId,proto3" json:"collection_id,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteCollectionByIdRequest) Descriptor deprecated 

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

Deprecated: Use DeleteCollectionByIdRequest.ProtoReflect.Descriptor instead.

func (*DeleteCollectionByIdRequest) GetCollectionId 

func (x *DeleteCollectionByIdRequest) GetCollectionId() string

func (*DeleteCollectionByIdRequest) GetKnowledgeBaseId 

func (x *DeleteCollectionByIdRequest) GetKnowledgeBaseId() string

func (*DeleteCollectionByIdRequest) ProtoMessage 

func (*DeleteCollectionByIdRequest) ProtoMessage()

func (*DeleteCollectionByIdRequest) ProtoReflect 

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

func (*DeleteCollectionByIdRequest) Reset 

func (x *DeleteCollectionByIdRequest) Reset()

func (*DeleteCollectionByIdRequest) String 

func (x *DeleteCollectionByIdRequest) String() string

type DeleteCollectionByIdResponse 

type DeleteCollectionByIdResponse struct {
	// contains filtered or unexported fields
}

func (*DeleteCollectionByIdResponse) Descriptor deprecated 

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

Deprecated: Use DeleteCollectionByIdResponse.ProtoReflect.Descriptor instead.

func (*DeleteCollectionByIdResponse) ProtoMessage 

func (*DeleteCollectionByIdResponse) ProtoMessage()

func (*DeleteCollectionByIdResponse) ProtoReflect 

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

func (*DeleteCollectionByIdResponse) Reset 

func (x *DeleteCollectionByIdResponse) Reset()

func (*DeleteCollectionByIdResponse) String 

func (x *DeleteCollectionByIdResponse) String() string

type GetCollectionByIdRequest 

type GetCollectionByIdRequest struct {
	KnowledgeBaseId string `protobuf:"bytes,1,opt,name=knowledge_base_id,json=knowledgeBaseId,proto3" json:"knowledge_base_id,omitempty"`
	CollectionId    string `protobuf:"bytes,2,opt,name=collection_id,json=collectionId,proto3" json:"collection_id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetCollectionByIdRequest) Descriptor deprecated 

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

Deprecated: Use GetCollectionByIdRequest.ProtoReflect.Descriptor instead.

func (*GetCollectionByIdRequest) GetCollectionId 

func (x *GetCollectionByIdRequest) GetCollectionId() string

func (*GetCollectionByIdRequest) GetKnowledgeBaseId 

func (x *GetCollectionByIdRequest) GetKnowledgeBaseId() string

func (*GetCollectionByIdRequest) ProtoMessage 

func (*GetCollectionByIdRequest) ProtoMessage()

func (*GetCollectionByIdRequest) ProtoReflect 

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

func (*GetCollectionByIdRequest) Reset 

func (x *GetCollectionByIdRequest) Reset()

func (*GetCollectionByIdRequest) String 

func (x *GetCollectionByIdRequest) String() string

type GetCollectionByIdResponse 

type GetCollectionByIdResponse struct {
	Collection *common.Collection `protobuf:"bytes,1,opt,name=collection,proto3" json:"collection,omitempty"`
	// contains filtered or unexported fields
}

func (*GetCollectionByIdResponse) Descriptor deprecated 

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

Deprecated: Use GetCollectionByIdResponse.ProtoReflect.Descriptor instead.

func (*GetCollectionByIdResponse) GetCollection 

func (x *GetCollectionByIdResponse) GetCollection() *common.Collection

func (*GetCollectionByIdResponse) ProtoMessage 

func (*GetCollectionByIdResponse) ProtoMessage()

func (*GetCollectionByIdResponse) ProtoReflect 

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

func (*GetCollectionByIdResponse) Reset 

func (x *GetCollectionByIdResponse) Reset()

func (*GetCollectionByIdResponse) String 

func (x *GetCollectionByIdResponse) String() string

type UnimplementedCollectionServiceServer 

type UnimplementedCollectionServiceServer struct {
}

UnimplementedCollectionServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedCollectionServiceServer) CreateCollection 

func (UnimplementedCollectionServiceServer) CreateCollection(context.Context, *CreateCollectionRequest) (*CreateCollectionResponse, error)

func (UnimplementedCollectionServiceServer) DeleteCollectionById 

func (UnimplementedCollectionServiceServer) DeleteCollectionById(context.Context, *DeleteCollectionByIdRequest) (*DeleteCollectionByIdResponse, error)

func (UnimplementedCollectionServiceServer) GetCollectionById 

func (UnimplementedCollectionServiceServer) GetCollectionById(context.Context, *GetCollectionByIdRequest) (*GetCollectionByIdResponse, error)

type UnsafeCollectionServiceServer 

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

UnsafeCollectionServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to CollectionServiceServer 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.