Documentation ¶
Overview ¶
Package httpeventsrc is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterHTTPEventSourceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterHTTPEventSourceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client HTTPEventSourceClient) error
- func RegisterHTTPEventSourceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterHTTPEventSourceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server HTTPEventSourceServer) error
- func RegisterHTTPEventSourceServer(s grpc.ServiceRegistrar, srv HTTPEventSourceServer)
- type BindRequest
- func (*BindRequest) Descriptor() ([]byte, []int)deprecated
- func (x *BindRequest) GetName() string
- func (x *BindRequest) GetProjectId() string
- func (x *BindRequest) GetRoutes() []*Route
- func (*BindRequest) ProtoMessage()
- func (x *BindRequest) ProtoReflect() protoreflect.Message
- func (x *BindRequest) Reset()
- func (x *BindRequest) String() string
- func (m *BindRequest) Validate() error
- type BindRequestValidationError
- func (e BindRequestValidationError) Cause() error
- func (e BindRequestValidationError) Error() string
- func (e BindRequestValidationError) ErrorName() string
- func (e BindRequestValidationError) Field() string
- func (e BindRequestValidationError) Key() bool
- func (e BindRequestValidationError) Reason() string
- type BindResponse
- type BindResponseValidationError
- func (e BindResponseValidationError) Cause() error
- func (e BindResponseValidationError) Error() string
- func (e BindResponseValidationError) ErrorName() string
- func (e BindResponseValidationError) Field() string
- func (e BindResponseValidationError) Key() bool
- func (e BindResponseValidationError) Reason() string
- type HTTPEventSourceClient
- type HTTPEventSourceServer
- type Route
- func (*Route) Descriptor() ([]byte, []int)deprecated
- func (x *Route) GetMethods() []string
- func (x *Route) GetName() string
- func (x *Route) GetPath() string
- func (*Route) ProtoMessage()
- func (x *Route) ProtoReflect() protoreflect.Message
- func (x *Route) Reset()
- func (x *Route) String() string
- func (m *Route) Validate() error
- type RouteValidationError
- type UnbindRequest
- func (*UnbindRequest) Descriptor() ([]byte, []int)deprecated
- func (x *UnbindRequest) GetName() string
- func (x *UnbindRequest) GetProjectId() string
- func (*UnbindRequest) ProtoMessage()
- func (x *UnbindRequest) ProtoReflect() protoreflect.Message
- func (x *UnbindRequest) Reset()
- func (x *UnbindRequest) String() string
- func (m *UnbindRequest) Validate() error
- type UnbindRequestValidationError
- func (e UnbindRequestValidationError) Cause() error
- func (e UnbindRequestValidationError) Error() string
- func (e UnbindRequestValidationError) ErrorName() string
- func (e UnbindRequestValidationError) Field() string
- func (e UnbindRequestValidationError) Key() bool
- func (e UnbindRequestValidationError) Reason() string
- type UnbindResponse
- type UnbindResponseValidationError
- func (e UnbindResponseValidationError) Cause() error
- func (e UnbindResponseValidationError) Error() string
- func (e UnbindResponseValidationError) ErrorName() string
- func (e UnbindResponseValidationError) Field() string
- func (e UnbindResponseValidationError) Key() bool
- func (e UnbindResponseValidationError) Reason() string
- type UnimplementedHTTPEventSourceServer
- type UnsafeHTTPEventSourceServer
Constants ¶
This section is empty.
Variables ¶
var File_httpeventsrc_src_proto protoreflect.FileDescriptor
var HTTPEventSource_ServiceDesc = grpc.ServiceDesc{ ServiceName: "autokitteh.httpeventsrc.HTTPEventSource", HandlerType: (*HTTPEventSourceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Bind", Handler: _HTTPEventSource_Bind_Handler, }, { MethodName: "Unbind", Handler: _HTTPEventSource_Unbind_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "httpeventsrc/src.proto", }
HTTPEventSource_ServiceDesc is the grpc.ServiceDesc for HTTPEventSource service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterHTTPEventSourceHandler ¶
func RegisterHTTPEventSourceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterHTTPEventSourceHandler registers the http handlers for service HTTPEventSource to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterHTTPEventSourceHandlerClient ¶
func RegisterHTTPEventSourceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client HTTPEventSourceClient) error
RegisterHTTPEventSourceHandlerClient registers the http handlers for service HTTPEventSource to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "HTTPEventSourceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "HTTPEventSourceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "HTTPEventSourceClient" to call the correct interceptors.
func RegisterHTTPEventSourceHandlerFromEndpoint ¶
func RegisterHTTPEventSourceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterHTTPEventSourceHandlerFromEndpoint is same as RegisterHTTPEventSourceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterHTTPEventSourceHandlerServer ¶
func RegisterHTTPEventSourceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server HTTPEventSourceServer) error
RegisterHTTPEventSourceHandlerServer registers the http handlers for service HTTPEventSource to "mux". UnaryRPC :call HTTPEventSourceServer 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 RegisterHTTPEventSourceHandlerFromEndpoint instead.
func RegisterHTTPEventSourceServer ¶
func RegisterHTTPEventSourceServer(s grpc.ServiceRegistrar, srv HTTPEventSourceServer)
Types ¶
type BindRequest ¶
type BindRequest struct { ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"` Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` Routes []*Route `protobuf:"bytes,3,rep,name=routes,proto3" json:"routes,omitempty"` // contains filtered or unexported fields }
func (*BindRequest) Descriptor
deprecated
func (*BindRequest) Descriptor() ([]byte, []int)
Deprecated: Use BindRequest.ProtoReflect.Descriptor instead.
func (*BindRequest) GetName ¶
func (x *BindRequest) GetName() string
func (*BindRequest) GetProjectId ¶
func (x *BindRequest) GetProjectId() string
func (*BindRequest) GetRoutes ¶
func (x *BindRequest) GetRoutes() []*Route
func (*BindRequest) ProtoMessage ¶
func (*BindRequest) ProtoMessage()
func (*BindRequest) ProtoReflect ¶
func (x *BindRequest) ProtoReflect() protoreflect.Message
func (*BindRequest) Reset ¶
func (x *BindRequest) Reset()
func (*BindRequest) String ¶
func (x *BindRequest) String() string
func (*BindRequest) Validate ¶
func (m *BindRequest) Validate() error
Validate checks the field values on BindRequest with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type BindRequestValidationError ¶
type BindRequestValidationError struct {
// contains filtered or unexported fields
}
BindRequestValidationError is the validation error returned by BindRequest.Validate if the designated constraints aren't met.
func (BindRequestValidationError) Cause ¶
func (e BindRequestValidationError) Cause() error
Cause function returns cause value.
func (BindRequestValidationError) Error ¶
func (e BindRequestValidationError) Error() string
Error satisfies the builtin error interface
func (BindRequestValidationError) ErrorName ¶
func (e BindRequestValidationError) ErrorName() string
ErrorName returns error name.
func (BindRequestValidationError) Field ¶
func (e BindRequestValidationError) Field() string
Field function returns field value.
func (BindRequestValidationError) Key ¶
func (e BindRequestValidationError) Key() bool
Key function returns key value.
func (BindRequestValidationError) Reason ¶
func (e BindRequestValidationError) Reason() string
Reason function returns reason value.
type BindResponse ¶
type BindResponse struct {
// contains filtered or unexported fields
}
func (*BindResponse) Descriptor
deprecated
func (*BindResponse) Descriptor() ([]byte, []int)
Deprecated: Use BindResponse.ProtoReflect.Descriptor instead.
func (*BindResponse) ProtoMessage ¶
func (*BindResponse) ProtoMessage()
func (*BindResponse) ProtoReflect ¶
func (x *BindResponse) ProtoReflect() protoreflect.Message
func (*BindResponse) Reset ¶
func (x *BindResponse) Reset()
func (*BindResponse) String ¶
func (x *BindResponse) String() string
func (*BindResponse) Validate ¶
func (m *BindResponse) Validate() error
Validate checks the field values on BindResponse with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type BindResponseValidationError ¶
type BindResponseValidationError struct {
// contains filtered or unexported fields
}
BindResponseValidationError is the validation error returned by BindResponse.Validate if the designated constraints aren't met.
func (BindResponseValidationError) Cause ¶
func (e BindResponseValidationError) Cause() error
Cause function returns cause value.
func (BindResponseValidationError) Error ¶
func (e BindResponseValidationError) Error() string
Error satisfies the builtin error interface
func (BindResponseValidationError) ErrorName ¶
func (e BindResponseValidationError) ErrorName() string
ErrorName returns error name.
func (BindResponseValidationError) Field ¶
func (e BindResponseValidationError) Field() string
Field function returns field value.
func (BindResponseValidationError) Key ¶
func (e BindResponseValidationError) Key() bool
Key function returns key value.
func (BindResponseValidationError) Reason ¶
func (e BindResponseValidationError) Reason() string
Reason function returns reason value.
type HTTPEventSourceClient ¶
type HTTPEventSourceClient interface { Bind(ctx context.Context, in *BindRequest, opts ...grpc.CallOption) (*BindResponse, error) Unbind(ctx context.Context, in *UnbindRequest, opts ...grpc.CallOption) (*UnbindResponse, error) }
HTTPEventSourceClient is the client API for HTTPEventSource 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 NewHTTPEventSourceClient ¶
func NewHTTPEventSourceClient(cc grpc.ClientConnInterface) HTTPEventSourceClient
type HTTPEventSourceServer ¶
type HTTPEventSourceServer interface { Bind(context.Context, *BindRequest) (*BindResponse, error) Unbind(context.Context, *UnbindRequest) (*UnbindResponse, error) // contains filtered or unexported methods }
HTTPEventSourceServer is the server API for HTTPEventSource service. All implementations must embed UnimplementedHTTPEventSourceServer for forward compatibility
type Route ¶
type Route struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"` Methods []string `protobuf:"bytes,3,rep,name=methods,proto3" json:"methods,omitempty"` // contains filtered or unexported fields }
func (*Route) Descriptor
deprecated
func (*Route) GetMethods ¶
func (*Route) ProtoMessage ¶
func (*Route) ProtoMessage()
func (*Route) ProtoReflect ¶
func (x *Route) ProtoReflect() protoreflect.Message
type RouteValidationError ¶
type RouteValidationError struct {
// contains filtered or unexported fields
}
RouteValidationError is the validation error returned by Route.Validate if the designated constraints aren't met.
func (RouteValidationError) Cause ¶
func (e RouteValidationError) Cause() error
Cause function returns cause value.
func (RouteValidationError) Error ¶
func (e RouteValidationError) Error() string
Error satisfies the builtin error interface
func (RouteValidationError) ErrorName ¶
func (e RouteValidationError) ErrorName() string
ErrorName returns error name.
func (RouteValidationError) Field ¶
func (e RouteValidationError) Field() string
Field function returns field value.
func (RouteValidationError) Key ¶
func (e RouteValidationError) Key() bool
Key function returns key value.
func (RouteValidationError) Reason ¶
func (e RouteValidationError) Reason() string
Reason function returns reason value.
type UnbindRequest ¶
type UnbindRequest struct { ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"` Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
func (*UnbindRequest) Descriptor
deprecated
func (*UnbindRequest) Descriptor() ([]byte, []int)
Deprecated: Use UnbindRequest.ProtoReflect.Descriptor instead.
func (*UnbindRequest) GetName ¶
func (x *UnbindRequest) GetName() string
func (*UnbindRequest) GetProjectId ¶
func (x *UnbindRequest) GetProjectId() string
func (*UnbindRequest) ProtoMessage ¶
func (*UnbindRequest) ProtoMessage()
func (*UnbindRequest) ProtoReflect ¶
func (x *UnbindRequest) ProtoReflect() protoreflect.Message
func (*UnbindRequest) Reset ¶
func (x *UnbindRequest) Reset()
func (*UnbindRequest) String ¶
func (x *UnbindRequest) String() string
func (*UnbindRequest) Validate ¶
func (m *UnbindRequest) Validate() error
Validate checks the field values on UnbindRequest with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type UnbindRequestValidationError ¶
type UnbindRequestValidationError struct {
// contains filtered or unexported fields
}
UnbindRequestValidationError is the validation error returned by UnbindRequest.Validate if the designated constraints aren't met.
func (UnbindRequestValidationError) Cause ¶
func (e UnbindRequestValidationError) Cause() error
Cause function returns cause value.
func (UnbindRequestValidationError) Error ¶
func (e UnbindRequestValidationError) Error() string
Error satisfies the builtin error interface
func (UnbindRequestValidationError) ErrorName ¶
func (e UnbindRequestValidationError) ErrorName() string
ErrorName returns error name.
func (UnbindRequestValidationError) Field ¶
func (e UnbindRequestValidationError) Field() string
Field function returns field value.
func (UnbindRequestValidationError) Key ¶
func (e UnbindRequestValidationError) Key() bool
Key function returns key value.
func (UnbindRequestValidationError) Reason ¶
func (e UnbindRequestValidationError) Reason() string
Reason function returns reason value.
type UnbindResponse ¶
type UnbindResponse struct {
// contains filtered or unexported fields
}
func (*UnbindResponse) Descriptor
deprecated
func (*UnbindResponse) Descriptor() ([]byte, []int)
Deprecated: Use UnbindResponse.ProtoReflect.Descriptor instead.
func (*UnbindResponse) ProtoMessage ¶
func (*UnbindResponse) ProtoMessage()
func (*UnbindResponse) ProtoReflect ¶
func (x *UnbindResponse) ProtoReflect() protoreflect.Message
func (*UnbindResponse) Reset ¶
func (x *UnbindResponse) Reset()
func (*UnbindResponse) String ¶
func (x *UnbindResponse) String() string
func (*UnbindResponse) Validate ¶
func (m *UnbindResponse) Validate() error
Validate checks the field values on UnbindResponse with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type UnbindResponseValidationError ¶
type UnbindResponseValidationError struct {
// contains filtered or unexported fields
}
UnbindResponseValidationError is the validation error returned by UnbindResponse.Validate if the designated constraints aren't met.
func (UnbindResponseValidationError) Cause ¶
func (e UnbindResponseValidationError) Cause() error
Cause function returns cause value.
func (UnbindResponseValidationError) Error ¶
func (e UnbindResponseValidationError) Error() string
Error satisfies the builtin error interface
func (UnbindResponseValidationError) ErrorName ¶
func (e UnbindResponseValidationError) ErrorName() string
ErrorName returns error name.
func (UnbindResponseValidationError) Field ¶
func (e UnbindResponseValidationError) Field() string
Field function returns field value.
func (UnbindResponseValidationError) Key ¶
func (e UnbindResponseValidationError) Key() bool
Key function returns key value.
func (UnbindResponseValidationError) Reason ¶
func (e UnbindResponseValidationError) Reason() string
Reason function returns reason value.
type UnimplementedHTTPEventSourceServer ¶
type UnimplementedHTTPEventSourceServer struct { }
UnimplementedHTTPEventSourceServer must be embedded to have forward compatible implementations.
func (UnimplementedHTTPEventSourceServer) Bind ¶
func (UnimplementedHTTPEventSourceServer) Bind(context.Context, *BindRequest) (*BindResponse, error)
func (UnimplementedHTTPEventSourceServer) Unbind ¶
func (UnimplementedHTTPEventSourceServer) Unbind(context.Context, *UnbindRequest) (*UnbindResponse, error)
type UnsafeHTTPEventSourceServer ¶
type UnsafeHTTPEventSourceServer interface {
// contains filtered or unexported methods
}
UnsafeHTTPEventSourceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to HTTPEventSourceServer will result in compilation errors.