Documentation
¶
Overview ¶
Package rpcv3 is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterClusterHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterClusterHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ClusterClient) error
- func RegisterClusterHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterClusterHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ClusterServer) error
- func RegisterClusterServer(s grpc.ServiceRegistrar, srv ClusterServer)
- type ClusterClient
- type ClusterServer
- type DeleteClusterResponse
- type RegisterClusterRequest
- func (*RegisterClusterRequest) Descriptor() ([]byte, []int)deprecated
- func (x *RegisterClusterRequest) GetSigningRequest() []byte
- func (x *RegisterClusterRequest) GetToken() string
- func (*RegisterClusterRequest) ProtoMessage()
- func (x *RegisterClusterRequest) ProtoReflect() protoreflect.Message
- func (x *RegisterClusterRequest) Reset()
- func (x *RegisterClusterRequest) String() string
- type RegisterClusterResponse
- func (*RegisterClusterResponse) Descriptor() ([]byte, []int)deprecated
- func (x *RegisterClusterResponse) GetCaCertificate() []byte
- func (x *RegisterClusterResponse) GetCertificate() []byte
- func (*RegisterClusterResponse) ProtoMessage()
- func (x *RegisterClusterResponse) ProtoReflect() protoreflect.Message
- func (x *RegisterClusterResponse) Reset()
- func (x *RegisterClusterResponse) String() string
- type SchedulerClient
- type SchedulerPool
- type UnimplementedClusterServer
- func (UnimplementedClusterServer) CreateCluster(context.Context, *v3.Cluster) (*v3.Cluster, error)
- func (UnimplementedClusterServer) DeleteCluster(context.Context, *v3.Cluster) (*DeleteClusterResponse, error)
- func (UnimplementedClusterServer) DownloadCluster(context.Context, *v3.Cluster) (*v31.HttpBody, error)
- func (UnimplementedClusterServer) GetCluster(context.Context, *v3.Cluster) (*v3.Cluster, error)
- func (UnimplementedClusterServer) GetClusters(context.Context, *v31.QueryOptions) (*v3.ClusterList, error)
- func (UnimplementedClusterServer) UpdateCluster(context.Context, *v3.Cluster) (*v3.Cluster, error)
- type UnsafeClusterServer
Constants ¶
This section is empty.
Variables ¶
var Cluster_ServiceDesc = grpc.ServiceDesc{ ServiceName: "paralus.dev.rpc.v3.Cluster", HandlerType: (*ClusterServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "CreateCluster", Handler: _Cluster_CreateCluster_Handler, }, { MethodName: "GetClusters", Handler: _Cluster_GetClusters_Handler, }, { MethodName: "GetCluster", Handler: _Cluster_GetCluster_Handler, }, { MethodName: "UpdateCluster", Handler: _Cluster_UpdateCluster_Handler, }, { MethodName: "DeleteCluster", Handler: _Cluster_DeleteCluster_Handler, }, { MethodName: "DownloadCluster", Handler: _Cluster_DownloadCluster_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "proto/rpc/scheduler/cluster.proto", }
Cluster_ServiceDesc is the grpc.ServiceDesc for Cluster service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_proto_rpc_scheduler_cluster_proto protoreflect.FileDescriptor
Functions ¶
func RegisterClusterHandler ¶
func RegisterClusterHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterClusterHandler registers the http handlers for service Cluster to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterClusterHandlerClient ¶
func RegisterClusterHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ClusterClient) error
RegisterClusterHandlerClient registers the http handlers for service Cluster to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "ClusterClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "ClusterClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "ClusterClient" to call the correct interceptors.
func RegisterClusterHandlerFromEndpoint ¶
func RegisterClusterHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterClusterHandlerFromEndpoint is same as RegisterClusterHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterClusterHandlerServer ¶
func RegisterClusterHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ClusterServer) error
RegisterClusterHandlerServer registers the http handlers for service Cluster to "mux". UnaryRPC :call ClusterServer 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 RegisterClusterHandlerFromEndpoint instead.
func RegisterClusterServer ¶
func RegisterClusterServer(s grpc.ServiceRegistrar, srv ClusterServer)
Types ¶
type ClusterClient ¶
type ClusterClient interface { CreateCluster(ctx context.Context, in *v3.Cluster, opts ...grpc.CallOption) (*v3.Cluster, error) GetClusters(ctx context.Context, in *v31.QueryOptions, opts ...grpc.CallOption) (*v3.ClusterList, error) GetCluster(ctx context.Context, in *v3.Cluster, opts ...grpc.CallOption) (*v3.Cluster, error) UpdateCluster(ctx context.Context, in *v3.Cluster, opts ...grpc.CallOption) (*v3.Cluster, error) DeleteCluster(ctx context.Context, in *v3.Cluster, opts ...grpc.CallOption) (*DeleteClusterResponse, error) DownloadCluster(ctx context.Context, in *v3.Cluster, opts ...grpc.CallOption) (*v31.HttpBody, error) }
ClusterClient is the client API for Cluster 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 NewClusterClient ¶
func NewClusterClient(cc grpc.ClientConnInterface) ClusterClient
type ClusterServer ¶
type ClusterServer interface { CreateCluster(context.Context, *v3.Cluster) (*v3.Cluster, error) GetClusters(context.Context, *v31.QueryOptions) (*v3.ClusterList, error) GetCluster(context.Context, *v3.Cluster) (*v3.Cluster, error) UpdateCluster(context.Context, *v3.Cluster) (*v3.Cluster, error) DeleteCluster(context.Context, *v3.Cluster) (*DeleteClusterResponse, error) DownloadCluster(context.Context, *v3.Cluster) (*v31.HttpBody, error) }
ClusterServer is the server API for Cluster service. All implementations should embed UnimplementedClusterServer for forward compatibility
type DeleteClusterResponse ¶
type DeleteClusterResponse struct {
// contains filtered or unexported fields
}
func (*DeleteClusterResponse) Descriptor
deprecated
func (*DeleteClusterResponse) Descriptor() ([]byte, []int)
Deprecated: Use DeleteClusterResponse.ProtoReflect.Descriptor instead.
func (*DeleteClusterResponse) ProtoMessage ¶
func (*DeleteClusterResponse) ProtoMessage()
func (*DeleteClusterResponse) ProtoReflect ¶
func (x *DeleteClusterResponse) ProtoReflect() protoreflect.Message
func (*DeleteClusterResponse) Reset ¶
func (x *DeleteClusterResponse) Reset()
func (*DeleteClusterResponse) String ¶
func (x *DeleteClusterResponse) String() string
type RegisterClusterRequest ¶
type RegisterClusterRequest struct { Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"` SigningRequest []byte `protobuf:"bytes,2,opt,name=signingRequest,proto3" json:"signingRequest,omitempty"` // contains filtered or unexported fields }
func (*RegisterClusterRequest) Descriptor
deprecated
func (*RegisterClusterRequest) Descriptor() ([]byte, []int)
Deprecated: Use RegisterClusterRequest.ProtoReflect.Descriptor instead.
func (*RegisterClusterRequest) GetSigningRequest ¶
func (x *RegisterClusterRequest) GetSigningRequest() []byte
func (*RegisterClusterRequest) GetToken ¶
func (x *RegisterClusterRequest) GetToken() string
func (*RegisterClusterRequest) ProtoMessage ¶
func (*RegisterClusterRequest) ProtoMessage()
func (*RegisterClusterRequest) ProtoReflect ¶
func (x *RegisterClusterRequest) ProtoReflect() protoreflect.Message
func (*RegisterClusterRequest) Reset ¶
func (x *RegisterClusterRequest) Reset()
func (*RegisterClusterRequest) String ¶
func (x *RegisterClusterRequest) String() string
type RegisterClusterResponse ¶
type RegisterClusterResponse struct { Certificate []byte `protobuf:"bytes,1,opt,name=certificate,proto3" json:"certificate,omitempty"` CaCertificate []byte `protobuf:"bytes,2,opt,name=caCertificate,proto3" json:"caCertificate,omitempty"` // contains filtered or unexported fields }
func (*RegisterClusterResponse) Descriptor
deprecated
func (*RegisterClusterResponse) Descriptor() ([]byte, []int)
Deprecated: Use RegisterClusterResponse.ProtoReflect.Descriptor instead.
func (*RegisterClusterResponse) GetCaCertificate ¶
func (x *RegisterClusterResponse) GetCaCertificate() []byte
func (*RegisterClusterResponse) GetCertificate ¶
func (x *RegisterClusterResponse) GetCertificate() []byte
func (*RegisterClusterResponse) ProtoMessage ¶
func (*RegisterClusterResponse) ProtoMessage()
func (*RegisterClusterResponse) ProtoReflect ¶
func (x *RegisterClusterResponse) ProtoReflect() protoreflect.Message
func (*RegisterClusterResponse) Reset ¶
func (x *RegisterClusterResponse) Reset()
func (*RegisterClusterResponse) String ¶
func (x *RegisterClusterResponse) String() string
type SchedulerClient ¶
type SchedulerClient interface { Unhealthy() Close() error ClusterClient }
SchedulerClient is the interface for accessing all the RPCs exposed by Cluster Scheduler
type SchedulerPool ¶
type SchedulerPool interface { Close() NewClient(ctx context.Context) (SchedulerClient, error) }
SchedulerPool maintains pool of grpc connections to scheduler service
func NewSchedulerPool ¶
func NewSchedulerPool(addr string, maxConn int) SchedulerPool
NewSchedulerPool new scheduler pool
type UnimplementedClusterServer ¶
type UnimplementedClusterServer struct { }
UnimplementedClusterServer should be embedded to have forward compatible implementations.
func (UnimplementedClusterServer) CreateCluster ¶
func (UnimplementedClusterServer) DeleteCluster ¶
func (UnimplementedClusterServer) DeleteCluster(context.Context, *v3.Cluster) (*DeleteClusterResponse, error)
func (UnimplementedClusterServer) DownloadCluster ¶
func (UnimplementedClusterServer) GetCluster ¶
func (UnimplementedClusterServer) GetClusters ¶
func (UnimplementedClusterServer) GetClusters(context.Context, *v31.QueryOptions) (*v3.ClusterList, error)
func (UnimplementedClusterServer) UpdateCluster ¶
type UnsafeClusterServer ¶
type UnsafeClusterServer interface {
// contains filtered or unexported methods
}
UnsafeClusterServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ClusterServer will result in compilation errors.