Documentation
¶
Overview ¶
Package designerv1 is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterDesignerAPIHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterDesignerAPIHandlerClient(ctx context.Context, mux *runtime.ServeMux, client DesignerAPIClient) error
- func RegisterDesignerAPIHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterDesignerAPIHandlerServer(ctx context.Context, mux *runtime.ServeMux, server DesignerAPIServer) error
- func RegisterDesignerAPIServer(s grpc.ServiceRegistrar, srv DesignerAPIServer)
- type CreateDesignerRequest
- type CreateDesignerResponse
- type DesignerAPIClient
- type DesignerAPIServer
- type GetDesignerRequest
- func (*GetDesignerRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetDesignerRequest) GetDesignerId() string
- func (*GetDesignerRequest) ProtoMessage()
- func (x *GetDesignerRequest) ProtoReflect() protoreflect.Message
- func (x *GetDesignerRequest) Reset()
- func (x *GetDesignerRequest) String() string
- type GetDesignerResponse
- type UnimplementedDesignerAPIServer
- type UnsafeDesignerAPIServer
Constants ¶
This section is empty.
Variables ¶
var File_designer_v1_designer_proto protoreflect.FileDescriptor
Functions ¶
func RegisterDesignerAPIHandler ¶
func RegisterDesignerAPIHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterDesignerAPIHandler registers the http handlers for service DesignerAPI to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterDesignerAPIHandlerClient ¶
func RegisterDesignerAPIHandlerClient(ctx context.Context, mux *runtime.ServeMux, client DesignerAPIClient) error
RegisterDesignerAPIHandlerClient registers the http handlers for service DesignerAPI to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "DesignerAPIClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "DesignerAPIClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "DesignerAPIClient" to call the correct interceptors.
func RegisterDesignerAPIHandlerFromEndpoint ¶
func RegisterDesignerAPIHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterDesignerAPIHandlerFromEndpoint is same as RegisterDesignerAPIHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterDesignerAPIHandlerServer ¶
func RegisterDesignerAPIHandlerServer(ctx context.Context, mux *runtime.ServeMux, server DesignerAPIServer) error
RegisterDesignerAPIHandlerServer registers the http handlers for service DesignerAPI to "mux". UnaryRPC :call DesignerAPIServer 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 RegisterDesignerAPIHandlerFromEndpoint instead.
func RegisterDesignerAPIServer ¶
func RegisterDesignerAPIServer(s grpc.ServiceRegistrar, srv DesignerAPIServer)
Types ¶
type CreateDesignerRequest ¶
type CreateDesignerRequest struct {
// contains filtered or unexported fields
}
func (*CreateDesignerRequest) Descriptor
deprecated
func (*CreateDesignerRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateDesignerRequest.ProtoReflect.Descriptor instead.
func (*CreateDesignerRequest) ProtoMessage ¶
func (*CreateDesignerRequest) ProtoMessage()
func (*CreateDesignerRequest) ProtoReflect ¶
func (x *CreateDesignerRequest) ProtoReflect() protoreflect.Message
func (*CreateDesignerRequest) Reset ¶
func (x *CreateDesignerRequest) Reset()
func (*CreateDesignerRequest) String ¶
func (x *CreateDesignerRequest) String() string
type CreateDesignerResponse ¶
type CreateDesignerResponse struct {
// contains filtered or unexported fields
}
func (*CreateDesignerResponse) Descriptor
deprecated
func (*CreateDesignerResponse) Descriptor() ([]byte, []int)
Deprecated: Use CreateDesignerResponse.ProtoReflect.Descriptor instead.
func (*CreateDesignerResponse) ProtoMessage ¶
func (*CreateDesignerResponse) ProtoMessage()
func (*CreateDesignerResponse) ProtoReflect ¶
func (x *CreateDesignerResponse) ProtoReflect() protoreflect.Message
func (*CreateDesignerResponse) Reset ¶
func (x *CreateDesignerResponse) Reset()
func (*CreateDesignerResponse) String ¶
func (x *CreateDesignerResponse) String() string
type DesignerAPIClient ¶
type DesignerAPIClient interface { CreateDesigner(ctx context.Context, in *CreateDesignerRequest, opts ...grpc.CallOption) (*CreateDesignerResponse, error) GetDesigner(ctx context.Context, in *GetDesignerRequest, opts ...grpc.CallOption) (*GetDesignerResponse, error) }
DesignerAPIClient is the client API for DesignerAPI 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 NewDesignerAPIClient ¶
func NewDesignerAPIClient(cc grpc.ClientConnInterface) DesignerAPIClient
type DesignerAPIServer ¶
type DesignerAPIServer interface { CreateDesigner(context.Context, *CreateDesignerRequest) (*CreateDesignerResponse, error) GetDesigner(context.Context, *GetDesignerRequest) (*GetDesignerResponse, error) }
DesignerAPIServer is the server API for DesignerAPI service. All implementations should embed UnimplementedDesignerAPIServer for forward compatibility
type GetDesignerRequest ¶
type GetDesignerRequest struct { DesignerId string `protobuf:"bytes,1,opt,name=designer_id,json=designerId,proto3" json:"designer_id,omitempty"` // contains filtered or unexported fields }
func (*GetDesignerRequest) Descriptor
deprecated
func (*GetDesignerRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetDesignerRequest.ProtoReflect.Descriptor instead.
func (*GetDesignerRequest) GetDesignerId ¶
func (x *GetDesignerRequest) GetDesignerId() string
func (*GetDesignerRequest) ProtoMessage ¶
func (*GetDesignerRequest) ProtoMessage()
func (*GetDesignerRequest) ProtoReflect ¶
func (x *GetDesignerRequest) ProtoReflect() protoreflect.Message
func (*GetDesignerRequest) Reset ¶
func (x *GetDesignerRequest) Reset()
func (*GetDesignerRequest) String ¶
func (x *GetDesignerRequest) String() string
type GetDesignerResponse ¶
type GetDesignerResponse struct {
// contains filtered or unexported fields
}
func (*GetDesignerResponse) Descriptor
deprecated
func (*GetDesignerResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetDesignerResponse.ProtoReflect.Descriptor instead.
func (*GetDesignerResponse) ProtoMessage ¶
func (*GetDesignerResponse) ProtoMessage()
func (*GetDesignerResponse) ProtoReflect ¶
func (x *GetDesignerResponse) ProtoReflect() protoreflect.Message
func (*GetDesignerResponse) Reset ¶
func (x *GetDesignerResponse) Reset()
func (*GetDesignerResponse) String ¶
func (x *GetDesignerResponse) String() string
type UnimplementedDesignerAPIServer ¶
type UnimplementedDesignerAPIServer struct { }
UnimplementedDesignerAPIServer should be embedded to have forward compatible implementations.
func (UnimplementedDesignerAPIServer) CreateDesigner ¶
func (UnimplementedDesignerAPIServer) CreateDesigner(context.Context, *CreateDesignerRequest) (*CreateDesignerResponse, error)
func (UnimplementedDesignerAPIServer) GetDesigner ¶
func (UnimplementedDesignerAPIServer) GetDesigner(context.Context, *GetDesignerRequest) (*GetDesignerResponse, error)
type UnsafeDesignerAPIServer ¶
type UnsafeDesignerAPIServer interface {
// contains filtered or unexported methods
}
UnsafeDesignerAPIServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to DesignerAPIServer will result in compilation errors.