Documentation ¶
Index ¶
- Variables
- func RegisterSandboxManagerAPIServer(s grpc.ServiceRegistrar, srv SandboxManagerAPIServer)
- func StatusToMap(status *StatusResponse) (map[string]any, error)
- func ToCIConfig(grpcSpec *structpb.Struct) (*config.ConnectInvocationConfig, error)
- func ToGRPCCIConfig(ciConfig *config.ConnectInvocationConfig) (*structpb.Struct, error)
- type RegisterSandboxRequest
- func (*RegisterSandboxRequest) Descriptor() ([]byte, []int)deprecated
- func (x *RegisterSandboxRequest) GetRoutingKey() string
- func (x *RegisterSandboxRequest) GetSandboxName() string
- func (*RegisterSandboxRequest) ProtoMessage()
- func (x *RegisterSandboxRequest) ProtoReflect() protoreflect.Message
- func (x *RegisterSandboxRequest) Reset()
- func (x *RegisterSandboxRequest) String() string
- type RegisterSandboxResponse
- type SandboxManagerAPIClient
- type SandboxManagerAPIServer
- type ShutdownRequest
- type ShutdownResponse
- type StatusRequest
- type StatusResponse
- func (*StatusResponse) Descriptor() ([]byte, []int)deprecated
- func (x *StatusResponse) GetCiConfig() *_struct.Struct
- func (x *StatusResponse) GetControlPlaneProxy() *api.ControlPlaneProxyStatus
- func (x *StatusResponse) GetHosts() *api.HostsStatus
- func (x *StatusResponse) GetLocalnet() *api.LocalNetStatus
- func (x *StatusResponse) GetOperatorInfo() *api.OperatorInfo
- func (x *StatusResponse) GetPortforward() *api.PortForwardStatus
- func (x *StatusResponse) GetSandboxes() []*api.SandboxStatus
- func (x *StatusResponse) GetWatcher() *api.WatcherStatus
- func (*StatusResponse) ProtoMessage()
- func (x *StatusResponse) ProtoReflect() protoreflect.Message
- func (x *StatusResponse) Reset()
- func (x *StatusResponse) String() string
- type UnimplementedSandboxManagerAPIServer
- func (UnimplementedSandboxManagerAPIServer) RegisterSandbox(context.Context, *RegisterSandboxRequest) (*RegisterSandboxResponse, error)
- func (UnimplementedSandboxManagerAPIServer) Shutdown(context.Context, *ShutdownRequest) (*ShutdownResponse, error)
- func (UnimplementedSandboxManagerAPIServer) Status(context.Context, *StatusRequest) (*StatusResponse, error)
- type UnsafeSandboxManagerAPIServer
Constants ¶
This section is empty.
Variables ¶
var File_internal_locald_api_sandboxmanager_sandbox_manager_api_proto protoreflect.FileDescriptor
var SandboxManagerAPI_ServiceDesc = grpc.ServiceDesc{ ServiceName: "sandboxmanager.SandboxManagerAPI", HandlerType: (*SandboxManagerAPIServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Status", Handler: _SandboxManagerAPI_Status_Handler, }, { MethodName: "Shutdown", Handler: _SandboxManagerAPI_Shutdown_Handler, }, { MethodName: "RegisterSandbox", Handler: _SandboxManagerAPI_RegisterSandbox_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "internal/locald/api/sandboxmanager/sandbox_manager_api.proto", }
SandboxManagerAPI_ServiceDesc is the grpc.ServiceDesc for SandboxManagerAPI service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterSandboxManagerAPIServer ¶
func RegisterSandboxManagerAPIServer(s grpc.ServiceRegistrar, srv SandboxManagerAPIServer)
func StatusToMap ¶
func StatusToMap(status *StatusResponse) (map[string]any, error)
func ToCIConfig ¶
func ToCIConfig(grpcSpec *structpb.Struct) (*config.ConnectInvocationConfig, error)
func ToGRPCCIConfig ¶
func ToGRPCCIConfig(ciConfig *config.ConnectInvocationConfig) (*structpb.Struct, error)
Types ¶
type RegisterSandboxRequest ¶ added in v0.6.0
type RegisterSandboxRequest struct { SandboxName string `protobuf:"bytes,1,opt,name=sandbox_name,json=sandboxName,proto3" json:"sandbox_name,omitempty"` RoutingKey string `protobuf:"bytes,2,opt,name=routing_key,json=routingKey,proto3" json:"routing_key,omitempty"` // contains filtered or unexported fields }
func (*RegisterSandboxRequest) Descriptor
deprecated
added in
v0.6.0
func (*RegisterSandboxRequest) Descriptor() ([]byte, []int)
Deprecated: Use RegisterSandboxRequest.ProtoReflect.Descriptor instead.
func (*RegisterSandboxRequest) GetRoutingKey ¶ added in v0.6.0
func (x *RegisterSandboxRequest) GetRoutingKey() string
func (*RegisterSandboxRequest) GetSandboxName ¶ added in v0.6.0
func (x *RegisterSandboxRequest) GetSandboxName() string
func (*RegisterSandboxRequest) ProtoMessage ¶ added in v0.6.0
func (*RegisterSandboxRequest) ProtoMessage()
func (*RegisterSandboxRequest) ProtoReflect ¶ added in v0.6.0
func (x *RegisterSandboxRequest) ProtoReflect() protoreflect.Message
func (*RegisterSandboxRequest) Reset ¶ added in v0.6.0
func (x *RegisterSandboxRequest) Reset()
func (*RegisterSandboxRequest) String ¶ added in v0.6.0
func (x *RegisterSandboxRequest) String() string
type RegisterSandboxResponse ¶ added in v0.6.0
type RegisterSandboxResponse struct {
// contains filtered or unexported fields
}
func (*RegisterSandboxResponse) Descriptor
deprecated
added in
v0.6.0
func (*RegisterSandboxResponse) Descriptor() ([]byte, []int)
Deprecated: Use RegisterSandboxResponse.ProtoReflect.Descriptor instead.
func (*RegisterSandboxResponse) ProtoMessage ¶ added in v0.6.0
func (*RegisterSandboxResponse) ProtoMessage()
func (*RegisterSandboxResponse) ProtoReflect ¶ added in v0.6.0
func (x *RegisterSandboxResponse) ProtoReflect() protoreflect.Message
func (*RegisterSandboxResponse) Reset ¶ added in v0.6.0
func (x *RegisterSandboxResponse) Reset()
func (*RegisterSandboxResponse) String ¶ added in v0.6.0
func (x *RegisterSandboxResponse) String() string
type SandboxManagerAPIClient ¶
type SandboxManagerAPIClient interface { // This method returns the status of the local controller Status(ctx context.Context, in *StatusRequest, opts ...grpc.CallOption) (*StatusResponse, error) // This method requests the root controller to shutdown Shutdown(ctx context.Context, in *ShutdownRequest, opts ...grpc.CallOption) (*ShutdownResponse, error) // This method is used to register sandboxes in the local controller. It is // mainly used in the context of old operators (the ones that don't support // WatchLocalSandboxes in tunnel-api) RegisterSandbox(ctx context.Context, in *RegisterSandboxRequest, opts ...grpc.CallOption) (*RegisterSandboxResponse, error) }
SandboxManagerAPIClient is the client API for SandboxManagerAPI 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 NewSandboxManagerAPIClient ¶
func NewSandboxManagerAPIClient(cc grpc.ClientConnInterface) SandboxManagerAPIClient
type SandboxManagerAPIServer ¶
type SandboxManagerAPIServer interface { // This method returns the status of the local controller Status(context.Context, *StatusRequest) (*StatusResponse, error) // This method requests the root controller to shutdown Shutdown(context.Context, *ShutdownRequest) (*ShutdownResponse, error) // This method is used to register sandboxes in the local controller. It is // mainly used in the context of old operators (the ones that don't support // WatchLocalSandboxes in tunnel-api) RegisterSandbox(context.Context, *RegisterSandboxRequest) (*RegisterSandboxResponse, error) // contains filtered or unexported methods }
SandboxManagerAPIServer is the server API for SandboxManagerAPI service. All implementations must embed UnimplementedSandboxManagerAPIServer for forward compatibility
type ShutdownRequest ¶
type ShutdownRequest struct {
// contains filtered or unexported fields
}
func (*ShutdownRequest) Descriptor
deprecated
func (*ShutdownRequest) Descriptor() ([]byte, []int)
Deprecated: Use ShutdownRequest.ProtoReflect.Descriptor instead.
func (*ShutdownRequest) ProtoMessage ¶
func (*ShutdownRequest) ProtoMessage()
func (*ShutdownRequest) ProtoReflect ¶
func (x *ShutdownRequest) ProtoReflect() protoreflect.Message
func (*ShutdownRequest) Reset ¶
func (x *ShutdownRequest) Reset()
func (*ShutdownRequest) String ¶
func (x *ShutdownRequest) String() string
type ShutdownResponse ¶
type ShutdownResponse struct {
// contains filtered or unexported fields
}
func (*ShutdownResponse) Descriptor
deprecated
func (*ShutdownResponse) Descriptor() ([]byte, []int)
Deprecated: Use ShutdownResponse.ProtoReflect.Descriptor instead.
func (*ShutdownResponse) ProtoMessage ¶
func (*ShutdownResponse) ProtoMessage()
func (*ShutdownResponse) ProtoReflect ¶
func (x *ShutdownResponse) ProtoReflect() protoreflect.Message
func (*ShutdownResponse) Reset ¶
func (x *ShutdownResponse) Reset()
func (*ShutdownResponse) String ¶
func (x *ShutdownResponse) String() string
type StatusRequest ¶
type StatusRequest struct {
// contains filtered or unexported fields
}
func (*StatusRequest) Descriptor
deprecated
func (*StatusRequest) Descriptor() ([]byte, []int)
Deprecated: Use StatusRequest.ProtoReflect.Descriptor instead.
func (*StatusRequest) ProtoMessage ¶
func (*StatusRequest) ProtoMessage()
func (*StatusRequest) ProtoReflect ¶
func (x *StatusRequest) ProtoReflect() protoreflect.Message
func (*StatusRequest) Reset ¶
func (x *StatusRequest) Reset()
func (*StatusRequest) String ¶
func (x *StatusRequest) String() string
type StatusResponse ¶
type StatusResponse struct { // connect invocation config // (instance of internal/config/locald.ConnectInvocationConfig) CiConfig *_struct.Struct `protobuf:"bytes,1,opt,name=ci_config,json=ciConfig,proto3" json:"ci_config,omitempty"` OperatorInfo *api.OperatorInfo `protobuf:"bytes,7,opt,name=operator_info,json=operatorInfo,proto3" json:"operator_info,omitempty"` Localnet *api.LocalNetStatus `protobuf:"bytes,2,opt,name=localnet,proto3" json:"localnet,omitempty"` Hosts *api.HostsStatus `protobuf:"bytes,3,opt,name=hosts,proto3" json:"hosts,omitempty"` Portforward *api.PortForwardStatus `protobuf:"bytes,4,opt,name=portforward,proto3" json:"portforward,omitempty"` ControlPlaneProxy *api.ControlPlaneProxyStatus `protobuf:"bytes,8,opt,name=control_plane_proxy,json=controlPlaneProxy,proto3" json:"control_plane_proxy,omitempty"` Watcher *api.WatcherStatus `protobuf:"bytes,6,opt,name=watcher,proto3" json:"watcher,omitempty"` Sandboxes []*api.SandboxStatus `protobuf:"bytes,5,rep,name=sandboxes,proto3" json:"sandboxes,omitempty"` // contains filtered or unexported fields }
func (*StatusResponse) Descriptor
deprecated
func (*StatusResponse) Descriptor() ([]byte, []int)
Deprecated: Use StatusResponse.ProtoReflect.Descriptor instead.
func (*StatusResponse) GetCiConfig ¶
func (x *StatusResponse) GetCiConfig() *_struct.Struct
func (*StatusResponse) GetControlPlaneProxy ¶ added in v0.7.0
func (x *StatusResponse) GetControlPlaneProxy() *api.ControlPlaneProxyStatus
func (*StatusResponse) GetHosts ¶
func (x *StatusResponse) GetHosts() *api.HostsStatus
func (*StatusResponse) GetLocalnet ¶
func (x *StatusResponse) GetLocalnet() *api.LocalNetStatus
func (*StatusResponse) GetOperatorInfo ¶ added in v0.6.0
func (x *StatusResponse) GetOperatorInfo() *api.OperatorInfo
func (*StatusResponse) GetPortforward ¶
func (x *StatusResponse) GetPortforward() *api.PortForwardStatus
func (*StatusResponse) GetSandboxes ¶
func (x *StatusResponse) GetSandboxes() []*api.SandboxStatus
func (*StatusResponse) GetWatcher ¶ added in v0.6.0
func (x *StatusResponse) GetWatcher() *api.WatcherStatus
func (*StatusResponse) ProtoMessage ¶
func (*StatusResponse) ProtoMessage()
func (*StatusResponse) ProtoReflect ¶
func (x *StatusResponse) ProtoReflect() protoreflect.Message
func (*StatusResponse) Reset ¶
func (x *StatusResponse) Reset()
func (*StatusResponse) String ¶
func (x *StatusResponse) String() string
type UnimplementedSandboxManagerAPIServer ¶
type UnimplementedSandboxManagerAPIServer struct { }
UnimplementedSandboxManagerAPIServer must be embedded to have forward compatible implementations.
func (UnimplementedSandboxManagerAPIServer) RegisterSandbox ¶ added in v0.6.0
func (UnimplementedSandboxManagerAPIServer) RegisterSandbox(context.Context, *RegisterSandboxRequest) (*RegisterSandboxResponse, error)
func (UnimplementedSandboxManagerAPIServer) Shutdown ¶
func (UnimplementedSandboxManagerAPIServer) Shutdown(context.Context, *ShutdownRequest) (*ShutdownResponse, error)
func (UnimplementedSandboxManagerAPIServer) Status ¶
func (UnimplementedSandboxManagerAPIServer) Status(context.Context, *StatusRequest) (*StatusResponse, error)
type UnsafeSandboxManagerAPIServer ¶
type UnsafeSandboxManagerAPIServer interface {
// contains filtered or unexported methods
}
UnsafeSandboxManagerAPIServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SandboxManagerAPIServer will result in compilation errors.