Documentation
¶
Overview ¶
Package v0 is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Constants
- Variables
- func RegisterCLIHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterCLIHandlerClient(ctx context.Context, mux *runtime.ServeMux, client CLIClient) error
- func RegisterCLIHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterCLIHandlerServer(ctx context.Context, mux *runtime.ServeMux, server CLIServer) error
- func RegisterCLIServer(s grpc.ServiceRegistrar, srv CLIServer)
- func RegisterTerminalServiceServer(s grpc.ServiceRegistrar, srv TerminalServiceServer)
- type ActiveResponse
- func (*ActiveResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ActiveResponse) GetModule() string
- func (x *ActiveResponse) GetService() string
- func (x *ActiveResponse) GetWorkspace() string
- func (*ActiveResponse) ProtoMessage()
- func (x *ActiveResponse) ProtoReflect() protoreflect.Message
- func (x *ActiveResponse) Reset()
- func (x *ActiveResponse) String() string
- type CLIClient
- type CLIServer
- type CLI_LogsClient
- type CLI_LogsServer
- type CloseTerminalRequest
- func (*CloseTerminalRequest) Descriptor() ([]byte, []int)deprecated
- func (x *CloseTerminalRequest) GetSessionId() string
- func (*CloseTerminalRequest) ProtoMessage()
- func (x *CloseTerminalRequest) ProtoReflect() protoreflect.Message
- func (x *CloseTerminalRequest) Reset()
- func (x *CloseTerminalRequest) String() string
- type CloseTerminalResponse
- type DestroyFlowRequest
- type DestroyFlowResponse
- type Directory
- type FileInfo
- func (*FileInfo) Descriptor() ([]byte, []int)deprecated
- func (x *FileInfo) GetContent() []byte
- func (x *FileInfo) GetIsDirectory() bool
- func (x *FileInfo) GetPath() string
- func (*FileInfo) ProtoMessage()
- func (x *FileInfo) ProtoReflect() protoreflect.Message
- func (x *FileInfo) Reset()
- func (x *FileInfo) String() string
- type FlowStatus
- type GetAddressRequest
- func (*GetAddressRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetAddressRequest) GetEndpoint() string
- func (x *GetAddressRequest) GetModule() string
- func (x *GetAddressRequest) GetService() string
- func (*GetAddressRequest) ProtoMessage()
- func (x *GetAddressRequest) ProtoReflect() protoreflect.Message
- func (x *GetAddressRequest) Reset()
- func (x *GetAddressRequest) String() string
- type GetAddressResponse
- func (*GetAddressResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetAddressResponse) GetAddress() string
- func (*GetAddressResponse) ProtoMessage()
- func (x *GetAddressResponse) ProtoReflect() protoreflect.Message
- func (x *GetAddressResponse) Reset()
- func (x *GetAddressResponse) String() string
- type GetAgentInformationRequest
- func (*GetAgentInformationRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetAgentInformationRequest) GetAgent() string
- func (*GetAgentInformationRequest) ProtoMessage()
- func (x *GetAgentInformationRequest) ProtoReflect() protoreflect.Message
- func (x *GetAgentInformationRequest) Reset()
- func (x *GetAgentInformationRequest) String() string
- type GetConfigurationRequest
- func (*GetConfigurationRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetConfigurationRequest) GetModule() string
- func (x *GetConfigurationRequest) GetService() string
- func (*GetConfigurationRequest) ProtoMessage()
- func (x *GetConfigurationRequest) ProtoReflect() protoreflect.Message
- func (x *GetConfigurationRequest) Reset()
- func (x *GetConfigurationRequest) String() string
- type GetConfigurationResponse
- func (*GetConfigurationResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetConfigurationResponse) GetConfiguration() *v01.Configuration
- func (*GetConfigurationResponse) ProtoMessage()
- func (x *GetConfigurationResponse) ProtoReflect() protoreflect.Message
- func (x *GetConfigurationResponse) Reset()
- func (x *GetConfigurationResponse) String() string
- type GetConfigurationsResponse
- func (*GetConfigurationsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetConfigurationsResponse) GetConfigurations() []*v01.Configuration
- func (*GetConfigurationsResponse) ProtoMessage()
- func (x *GetConfigurationsResponse) ProtoReflect() protoreflect.Message
- func (x *GetConfigurationsResponse) Reset()
- func (x *GetConfigurationsResponse) String() string
- type GetNetworkMappingsRequest
- func (*GetNetworkMappingsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetNetworkMappingsRequest) GetModule() string
- func (x *GetNetworkMappingsRequest) GetService() string
- func (*GetNetworkMappingsRequest) ProtoMessage()
- func (x *GetNetworkMappingsRequest) ProtoReflect() protoreflect.Message
- func (x *GetNetworkMappingsRequest) Reset()
- func (x *GetNetworkMappingsRequest) String() string
- type GetNetworkMappingsResponse
- func (*GetNetworkMappingsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetNetworkMappingsResponse) GetNetworkMappings() []*v01.NetworkMapping
- func (*GetNetworkMappingsResponse) ProtoMessage()
- func (x *GetNetworkMappingsResponse) ProtoReflect() protoreflect.Message
- func (x *GetNetworkMappingsResponse) Reset()
- func (x *GetNetworkMappingsResponse) String() string
- type ListTerminalsRequest
- type ListTerminalsResponse
- func (*ListTerminalsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListTerminalsResponse) GetTerminals() []*TerminalInfo
- func (*ListTerminalsResponse) ProtoMessage()
- func (x *ListTerminalsResponse) ProtoReflect() protoreflect.Message
- func (x *ListTerminalsResponse) Reset()
- func (x *ListTerminalsResponse) String() string
- type MultiGraphResponse
- func (*MultiGraphResponse) Descriptor() ([]byte, []int)deprecated
- func (x *MultiGraphResponse) GetGraphs() []*v0.GraphResponse
- func (*MultiGraphResponse) ProtoMessage()
- func (x *MultiGraphResponse) ProtoReflect() protoreflect.Message
- func (x *MultiGraphResponse) Reset()
- func (x *MultiGraphResponse) String() string
- type OpenTerminalRequest
- func (*OpenTerminalRequest) Descriptor() ([]byte, []int)deprecated
- func (x *OpenTerminalRequest) GetCols() uint32
- func (x *OpenTerminalRequest) GetModule() string
- func (x *OpenTerminalRequest) GetRows() uint32
- func (x *OpenTerminalRequest) GetService() string
- func (x *OpenTerminalRequest) GetShell() string
- func (*OpenTerminalRequest) ProtoMessage()
- func (x *OpenTerminalRequest) ProtoReflect() protoreflect.Message
- func (x *OpenTerminalRequest) Reset()
- func (x *OpenTerminalRequest) String() string
- type OpenTerminalResponse
- func (*OpenTerminalResponse) Descriptor() ([]byte, []int)deprecated
- func (x *OpenTerminalResponse) GetSessionId() string
- func (x *OpenTerminalResponse) GetShell() string
- func (x *OpenTerminalResponse) GetWorkingDir() string
- func (*OpenTerminalResponse) ProtoMessage()
- func (x *OpenTerminalResponse) ProtoReflect() protoreflect.Message
- func (x *OpenTerminalResponse) Reset()
- func (x *OpenTerminalResponse) String() string
- type ResizeTerminalRequest
- func (*ResizeTerminalRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ResizeTerminalRequest) GetCols() uint32
- func (x *ResizeTerminalRequest) GetRows() uint32
- func (x *ResizeTerminalRequest) GetSessionId() string
- func (*ResizeTerminalRequest) ProtoMessage()
- func (x *ResizeTerminalRequest) ProtoReflect() protoreflect.Message
- func (x *ResizeTerminalRequest) Reset()
- func (x *ResizeTerminalRequest) String() string
- type ResizeTerminalResponse
- type RunningInformation
- func (*RunningInformation) Descriptor() ([]byte, []int)deprecated
- func (x *RunningInformation) GetAgentPid() int32
- func (x *RunningInformation) GetModule() string
- func (x *RunningInformation) GetService() string
- func (*RunningInformation) ProtoMessage()
- func (x *RunningInformation) ProtoReflect() protoreflect.Message
- func (x *RunningInformation) Reset()
- func (x *RunningInformation) String() string
- type StopFlowRequest
- type StopFlowResponse
- type TerminalInfo
- func (*TerminalInfo) Descriptor() ([]byte, []int)deprecated
- func (x *TerminalInfo) GetModule() string
- func (x *TerminalInfo) GetService() string
- func (x *TerminalInfo) GetSessionId() string
- func (x *TerminalInfo) GetShell() string
- func (x *TerminalInfo) GetWorkingDir() string
- func (*TerminalInfo) ProtoMessage()
- func (x *TerminalInfo) ProtoReflect() protoreflect.Message
- func (x *TerminalInfo) Reset()
- func (x *TerminalInfo) String() string
- type TerminalInput
- func (*TerminalInput) Descriptor() ([]byte, []int)deprecated
- func (x *TerminalInput) GetData() []byte
- func (x *TerminalInput) GetSessionId() string
- func (*TerminalInput) ProtoMessage()
- func (x *TerminalInput) ProtoReflect() protoreflect.Message
- func (x *TerminalInput) Reset()
- func (x *TerminalInput) String() string
- type TerminalOutput
- func (*TerminalOutput) Descriptor() ([]byte, []int)deprecated
- func (x *TerminalOutput) GetData() []byte
- func (x *TerminalOutput) GetDone() bool
- func (x *TerminalOutput) GetExitCode() int32
- func (x *TerminalOutput) GetSessionId() string
- func (*TerminalOutput) ProtoMessage()
- func (x *TerminalOutput) ProtoReflect() protoreflect.Message
- func (x *TerminalOutput) Reset()
- func (x *TerminalOutput) String() string
- type TerminalServiceClient
- type TerminalServiceServer
- type TerminalService_AttachClient
- type TerminalService_AttachServer
- type UnimplementedCLIServer
- func (UnimplementedCLIServer) ActiveLogHistory(context.Context, *v02.LogRequest) (*v02.LogResponse, error)
- func (UnimplementedCLIServer) DestroyFlow(context.Context, *DestroyFlowRequest) (*DestroyFlowResponse, error)
- func (UnimplementedCLIServer) GetActive(context.Context, *emptypb.Empty) (*ActiveResponse, error)
- func (UnimplementedCLIServer) GetAddresses(context.Context, *GetAddressRequest) (*GetAddressResponse, error)
- func (UnimplementedCLIServer) GetAgentInformation(context.Context, *GetAgentInformationRequest) (*v0.AgentInformation, error)
- func (UnimplementedCLIServer) GetConfiguration(context.Context, *GetConfigurationRequest) (*GetConfigurationResponse, error)
- func (UnimplementedCLIServer) GetDependenciesConfigurations(context.Context, *GetConfigurationRequest) (*GetConfigurationsResponse, error)
- func (UnimplementedCLIServer) GetDependenciesNetworkMappings(context.Context, *GetNetworkMappingsRequest) (*GetNetworkMappingsResponse, error)
- func (UnimplementedCLIServer) GetFlowStatus(context.Context, *emptypb.Empty) (*FlowStatus, error)
- func (UnimplementedCLIServer) GetRuntimeConfigurations(context.Context, *GetConfigurationRequest) (*GetConfigurationsResponse, error)
- func (UnimplementedCLIServer) GetWorkspaceInventory(context.Context, *emptypb.Empty) (*v01.Workspace, error)
- func (UnimplementedCLIServer) GetWorkspacePublicModulesDependencyGraph(context.Context, *emptypb.Empty) (*MultiGraphResponse, error)
- func (UnimplementedCLIServer) GetWorkspaceServiceDependencyGraph(context.Context, *emptypb.Empty) (*v02.GraphResponse, error)
- func (UnimplementedCLIServer) Logs(*emptypb.Empty, grpc.ServerStreamingServer[v02.Log]) error
- func (UnimplementedCLIServer) Ping(context.Context, *emptypb.Empty) (*emptypb.Empty, error)
- func (UnimplementedCLIServer) StopFlow(context.Context, *StopFlowRequest) (*StopFlowResponse, error)
- type UnimplementedTerminalServiceServer
- func (UnimplementedTerminalServiceServer) Attach(grpc.BidiStreamingServer[TerminalInput, TerminalOutput]) error
- func (UnimplementedTerminalServiceServer) Close(context.Context, *CloseTerminalRequest) (*CloseTerminalResponse, error)
- func (UnimplementedTerminalServiceServer) List(context.Context, *ListTerminalsRequest) (*ListTerminalsResponse, error)
- func (UnimplementedTerminalServiceServer) Open(context.Context, *OpenTerminalRequest) (*OpenTerminalResponse, error)
- func (UnimplementedTerminalServiceServer) Resize(context.Context, *ResizeTerminalRequest) (*ResizeTerminalResponse, error)
- type UnsafeCLIServer
- type UnsafeTerminalServiceServer
Constants ¶
const ( CLI_Ping_FullMethodName = "/codefly.cli.v0.CLI/Ping" CLI_GetAgentInformation_FullMethodName = "/codefly.cli.v0.CLI/GetAgentInformation" CLI_GetWorkspaceInventory_FullMethodName = "/codefly.cli.v0.CLI/GetWorkspaceInventory" CLI_GetWorkspaceServiceDependencyGraph_FullMethodName = "/codefly.cli.v0.CLI/GetWorkspaceServiceDependencyGraph" CLI_GetWorkspacePublicModulesDependencyGraph_FullMethodName = "/codefly.cli.v0.CLI/GetWorkspacePublicModulesDependencyGraph" CLI_GetActive_FullMethodName = "/codefly.cli.v0.CLI/GetActive" CLI_GetAddresses_FullMethodName = "/codefly.cli.v0.CLI/GetAddresses" CLI_GetConfiguration_FullMethodName = "/codefly.cli.v0.CLI/GetConfiguration" CLI_GetDependenciesConfigurations_FullMethodName = "/codefly.cli.v0.CLI/GetDependenciesConfigurations" CLI_GetDependenciesNetworkMappings_FullMethodName = "/codefly.cli.v0.CLI/GetDependenciesNetworkMappings" CLI_GetRuntimeConfigurations_FullMethodName = "/codefly.cli.v0.CLI/GetRuntimeConfigurations" CLI_Logs_FullMethodName = "/codefly.cli.v0.CLI/Logs" CLI_ActiveLogHistory_FullMethodName = "/codefly.cli.v0.CLI/ActiveLogHistory" CLI_GetFlowStatus_FullMethodName = "/codefly.cli.v0.CLI/GetFlowStatus" CLI_StopFlow_FullMethodName = "/codefly.cli.v0.CLI/StopFlow" CLI_DestroyFlow_FullMethodName = "/codefly.cli.v0.CLI/DestroyFlow" )
const ( TerminalService_Open_FullMethodName = "/codefly.cli.v0.TerminalService/Open" TerminalService_Attach_FullMethodName = "/codefly.cli.v0.TerminalService/Attach" TerminalService_Resize_FullMethodName = "/codefly.cli.v0.TerminalService/Resize" TerminalService_Close_FullMethodName = "/codefly.cli.v0.TerminalService/Close" TerminalService_List_FullMethodName = "/codefly.cli.v0.TerminalService/List" )
Variables ¶
var CLI_ServiceDesc = grpc.ServiceDesc{ ServiceName: "codefly.cli.v0.CLI", HandlerType: (*CLIServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Ping", Handler: _CLI_Ping_Handler, }, { MethodName: "GetAgentInformation", Handler: _CLI_GetAgentInformation_Handler, }, { MethodName: "GetWorkspaceInventory", Handler: _CLI_GetWorkspaceInventory_Handler, }, { MethodName: "GetWorkspaceServiceDependencyGraph", Handler: _CLI_GetWorkspaceServiceDependencyGraph_Handler, }, { MethodName: "GetWorkspacePublicModulesDependencyGraph", Handler: _CLI_GetWorkspacePublicModulesDependencyGraph_Handler, }, { MethodName: "GetActive", Handler: _CLI_GetActive_Handler, }, { MethodName: "GetAddresses", Handler: _CLI_GetAddresses_Handler, }, { MethodName: "GetConfiguration", Handler: _CLI_GetConfiguration_Handler, }, { MethodName: "GetDependenciesConfigurations", Handler: _CLI_GetDependenciesConfigurations_Handler, }, { MethodName: "GetDependenciesNetworkMappings", Handler: _CLI_GetDependenciesNetworkMappings_Handler, }, { MethodName: "GetRuntimeConfigurations", Handler: _CLI_GetRuntimeConfigurations_Handler, }, { MethodName: "ActiveLogHistory", Handler: _CLI_ActiveLogHistory_Handler, }, { MethodName: "GetFlowStatus", Handler: _CLI_GetFlowStatus_Handler, }, { MethodName: "StopFlow", Handler: _CLI_StopFlow_Handler, }, { MethodName: "DestroyFlow", Handler: _CLI_DestroyFlow_Handler, }, }, Streams: []grpc.StreamDesc{ { StreamName: "Logs", Handler: _CLI_Logs_Handler, ServerStreams: true, }, }, Metadata: "codefly/cli/v0/cli.proto", }
CLI_ServiceDesc is the grpc.ServiceDesc for CLI service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_codefly_cli_v0_cli_proto protoreflect.FileDescriptor
var File_codefly_cli_v0_terminal_proto protoreflect.FileDescriptor
var File_codefly_cli_v0_utils_proto protoreflect.FileDescriptor
var TerminalService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "codefly.cli.v0.TerminalService", HandlerType: (*TerminalServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Open", Handler: _TerminalService_Open_Handler, }, { MethodName: "Resize", Handler: _TerminalService_Resize_Handler, }, { MethodName: "Close", Handler: _TerminalService_Close_Handler, }, { MethodName: "List", Handler: _TerminalService_List_Handler, }, }, Streams: []grpc.StreamDesc{ { StreamName: "Attach", Handler: _TerminalService_Attach_Handler, ServerStreams: true, ClientStreams: true, }, }, Metadata: "codefly/cli/v0/terminal.proto", }
TerminalService_ServiceDesc is the grpc.ServiceDesc for TerminalService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterCLIHandler ¶
RegisterCLIHandler registers the http handlers for service CLI to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterCLIHandlerClient ¶
RegisterCLIHandlerClient registers the http handlers for service CLI to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "CLIClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "CLIClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "CLIClient" to call the correct interceptors.
func RegisterCLIHandlerFromEndpoint ¶
func RegisterCLIHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterCLIHandlerFromEndpoint is same as RegisterCLIHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterCLIHandlerServer ¶
RegisterCLIHandlerServer registers the http handlers for service CLI to "mux". UnaryRPC :call CLIServer 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 RegisterCLIHandlerFromEndpoint instead.
func RegisterCLIServer ¶
func RegisterCLIServer(s grpc.ServiceRegistrar, srv CLIServer)
func RegisterTerminalServiceServer ¶ added in v0.1.155
func RegisterTerminalServiceServer(s grpc.ServiceRegistrar, srv TerminalServiceServer)
Types ¶
type ActiveResponse ¶
type ActiveResponse struct {
// workspace is the Codefly workspace name that scopes modules and services.
Workspace string `protobuf:"bytes,1,opt,name=workspace,proto3" json:"workspace,omitempty"`
// module is the Codefly module name that groups services.
Module string `protobuf:"bytes,2,opt,name=module,proto3" json:"module,omitempty"`
// service is the Codefly service name, optionally scoped by module in callers.
Service string `protobuf:"bytes,3,opt,name=service,proto3" json:"service,omitempty"`
// contains filtered or unexported fields
}
ActiveResponse reports the workspace/module/service context selected by the CLI.
func (*ActiveResponse) Descriptor
deprecated
func (*ActiveResponse) Descriptor() ([]byte, []int)
Deprecated: Use ActiveResponse.ProtoReflect.Descriptor instead.
func (*ActiveResponse) GetModule ¶
func (x *ActiveResponse) GetModule() string
func (*ActiveResponse) GetService ¶
func (x *ActiveResponse) GetService() string
func (*ActiveResponse) GetWorkspace ¶
func (x *ActiveResponse) GetWorkspace() string
func (*ActiveResponse) ProtoMessage ¶
func (*ActiveResponse) ProtoMessage()
func (*ActiveResponse) ProtoReflect ¶
func (x *ActiveResponse) ProtoReflect() protoreflect.Message
func (*ActiveResponse) Reset ¶
func (x *ActiveResponse) Reset()
func (*ActiveResponse) String ¶
func (x *ActiveResponse) String() string
type CLIClient ¶
type CLIClient interface {
// Ping checks that the CLI bridge is reachable.
Ping(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*emptypb.Empty, error)
// GetAgentInformation returns metadata and documentation for an installed agent.
GetAgentInformation(ctx context.Context, in *GetAgentInformationRequest, opts ...grpc.CallOption) (*v0.AgentInformation, error)
// GetWorkspaceInventory returns the loaded workspace resource tree.
GetWorkspaceInventory(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*v01.Workspace, error)
// GetWorkspaceServiceDependencyGraph returns the service dependency DAG for the workspace.
GetWorkspaceServiceDependencyGraph(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*v02.GraphResponse, error)
// GetWorkspacePublicModulesDependencyGraph returns graphs of public module-facing endpoints.
GetWorkspacePublicModulesDependencyGraph(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*MultiGraphResponse, error)
// GetActive returns the CLI's current workspace/module/service selection.
GetActive(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*ActiveResponse, error)
// GetAddresses returns the concrete address for a service endpoint.
GetAddresses(ctx context.Context, in *GetAddressRequest, opts ...grpc.CallOption) (*GetAddressResponse, error)
// GetConfiguration returns configuration declared by the target service.
GetConfiguration(ctx context.Context, in *GetConfigurationRequest, opts ...grpc.CallOption) (*GetConfigurationResponse, error)
// GetDependenciesConfigurations returns configuration exposed by upstream services.
GetDependenciesConfigurations(ctx context.Context, in *GetConfigurationRequest, opts ...grpc.CallOption) (*GetConfigurationsResponse, error)
// GetDependenciesNetworkMappings returns network mappings exposed by upstream services.
GetDependenciesNetworkMappings(ctx context.Context, in *GetNetworkMappingsRequest, opts ...grpc.CallOption) (*GetNetworkMappingsResponse, error)
// GetRuntimeConfigurations returns configuration produced by a running service.
GetRuntimeConfigurations(ctx context.Context, in *GetConfigurationRequest, opts ...grpc.CallOption) (*GetConfigurationsResponse, error)
// Logs streams live workspace log events.
Logs(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (grpc.ServerStreamingClient[v02.Log], error)
// ActiveLogHistory returns persisted log events for the active workspace session.
ActiveLogHistory(ctx context.Context, in *v02.LogRequest, opts ...grpc.CallOption) (*v02.LogResponse, error)
// GetFlowStatus reports readiness for the active orchestration flow.
GetFlowStatus(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*FlowStatus, error)
// StopFlow stops the active orchestration flow.
StopFlow(ctx context.Context, in *StopFlowRequest, opts ...grpc.CallOption) (*StopFlowResponse, error)
// DestroyFlow tears down resources owned by the active orchestration flow.
DestroyFlow(ctx context.Context, in *DestroyFlowRequest, opts ...grpc.CallOption) (*DestroyFlowResponse, error)
}
CLIClient is the client API for CLI 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.
CLI exposes the local Codefly command bridge used by companion UIs and integrations.
func NewCLIClient ¶
func NewCLIClient(cc grpc.ClientConnInterface) CLIClient
type CLIServer ¶
type CLIServer interface {
// Ping checks that the CLI bridge is reachable.
Ping(context.Context, *emptypb.Empty) (*emptypb.Empty, error)
// GetAgentInformation returns metadata and documentation for an installed agent.
GetAgentInformation(context.Context, *GetAgentInformationRequest) (*v0.AgentInformation, error)
// GetWorkspaceInventory returns the loaded workspace resource tree.
GetWorkspaceInventory(context.Context, *emptypb.Empty) (*v01.Workspace, error)
// GetWorkspaceServiceDependencyGraph returns the service dependency DAG for the workspace.
GetWorkspaceServiceDependencyGraph(context.Context, *emptypb.Empty) (*v02.GraphResponse, error)
// GetWorkspacePublicModulesDependencyGraph returns graphs of public module-facing endpoints.
GetWorkspacePublicModulesDependencyGraph(context.Context, *emptypb.Empty) (*MultiGraphResponse, error)
// GetActive returns the CLI's current workspace/module/service selection.
GetActive(context.Context, *emptypb.Empty) (*ActiveResponse, error)
// GetAddresses returns the concrete address for a service endpoint.
GetAddresses(context.Context, *GetAddressRequest) (*GetAddressResponse, error)
// GetConfiguration returns configuration declared by the target service.
GetConfiguration(context.Context, *GetConfigurationRequest) (*GetConfigurationResponse, error)
// GetDependenciesConfigurations returns configuration exposed by upstream services.
GetDependenciesConfigurations(context.Context, *GetConfigurationRequest) (*GetConfigurationsResponse, error)
// GetDependenciesNetworkMappings returns network mappings exposed by upstream services.
GetDependenciesNetworkMappings(context.Context, *GetNetworkMappingsRequest) (*GetNetworkMappingsResponse, error)
// GetRuntimeConfigurations returns configuration produced by a running service.
GetRuntimeConfigurations(context.Context, *GetConfigurationRequest) (*GetConfigurationsResponse, error)
// Logs streams live workspace log events.
Logs(*emptypb.Empty, grpc.ServerStreamingServer[v02.Log]) error
// ActiveLogHistory returns persisted log events for the active workspace session.
ActiveLogHistory(context.Context, *v02.LogRequest) (*v02.LogResponse, error)
// GetFlowStatus reports readiness for the active orchestration flow.
GetFlowStatus(context.Context, *emptypb.Empty) (*FlowStatus, error)
// StopFlow stops the active orchestration flow.
StopFlow(context.Context, *StopFlowRequest) (*StopFlowResponse, error)
// DestroyFlow tears down resources owned by the active orchestration flow.
DestroyFlow(context.Context, *DestroyFlowRequest) (*DestroyFlowResponse, error)
// contains filtered or unexported methods
}
CLIServer is the server API for CLI service. All implementations must embed UnimplementedCLIServer for forward compatibility.
CLI exposes the local Codefly command bridge used by companion UIs and integrations.
type CLI_LogsClient ¶
type CLI_LogsClient = grpc.ServerStreamingClient[v02.Log]
This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
type CLI_LogsServer ¶
type CLI_LogsServer = grpc.ServerStreamingServer[v02.Log]
This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
type CloseTerminalRequest ¶ added in v0.1.155
type CloseTerminalRequest struct {
// session_id identifies the terminal session to close.
SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
// contains filtered or unexported fields
}
CloseTerminalRequest identifies the terminal session to close.
func (*CloseTerminalRequest) Descriptor
deprecated
added in
v0.1.155
func (*CloseTerminalRequest) Descriptor() ([]byte, []int)
Deprecated: Use CloseTerminalRequest.ProtoReflect.Descriptor instead.
func (*CloseTerminalRequest) GetSessionId ¶ added in v0.1.155
func (x *CloseTerminalRequest) GetSessionId() string
func (*CloseTerminalRequest) ProtoMessage ¶ added in v0.1.155
func (*CloseTerminalRequest) ProtoMessage()
func (*CloseTerminalRequest) ProtoReflect ¶ added in v0.1.155
func (x *CloseTerminalRequest) ProtoReflect() protoreflect.Message
func (*CloseTerminalRequest) Reset ¶ added in v0.1.155
func (x *CloseTerminalRequest) Reset()
func (*CloseTerminalRequest) String ¶ added in v0.1.155
func (x *CloseTerminalRequest) String() string
type CloseTerminalResponse ¶ added in v0.1.155
type CloseTerminalResponse struct {
// contains filtered or unexported fields
}
CloseTerminalResponse acknowledges a terminal close request.
func (*CloseTerminalResponse) Descriptor
deprecated
added in
v0.1.155
func (*CloseTerminalResponse) Descriptor() ([]byte, []int)
Deprecated: Use CloseTerminalResponse.ProtoReflect.Descriptor instead.
func (*CloseTerminalResponse) ProtoMessage ¶ added in v0.1.155
func (*CloseTerminalResponse) ProtoMessage()
func (*CloseTerminalResponse) ProtoReflect ¶ added in v0.1.155
func (x *CloseTerminalResponse) ProtoReflect() protoreflect.Message
func (*CloseTerminalResponse) Reset ¶ added in v0.1.155
func (x *CloseTerminalResponse) Reset()
func (*CloseTerminalResponse) String ¶ added in v0.1.155
func (x *CloseTerminalResponse) String() string
type DestroyFlowRequest ¶
type DestroyFlowRequest struct {
// contains filtered or unexported fields
}
DestroyFlowRequest asks the CLI to destroy resources owned by the active flow.
func (*DestroyFlowRequest) Descriptor
deprecated
func (*DestroyFlowRequest) Descriptor() ([]byte, []int)
Deprecated: Use DestroyFlowRequest.ProtoReflect.Descriptor instead.
func (*DestroyFlowRequest) ProtoMessage ¶
func (*DestroyFlowRequest) ProtoMessage()
func (*DestroyFlowRequest) ProtoReflect ¶
func (x *DestroyFlowRequest) ProtoReflect() protoreflect.Message
func (*DestroyFlowRequest) Reset ¶
func (x *DestroyFlowRequest) Reset()
func (*DestroyFlowRequest) String ¶
func (x *DestroyFlowRequest) String() string
type DestroyFlowResponse ¶
type DestroyFlowResponse struct {
// contains filtered or unexported fields
}
DestroyFlowResponse acknowledges that destroy flow cleanup was requested.
func (*DestroyFlowResponse) Descriptor
deprecated
func (*DestroyFlowResponse) Descriptor() ([]byte, []int)
Deprecated: Use DestroyFlowResponse.ProtoReflect.Descriptor instead.
func (*DestroyFlowResponse) ProtoMessage ¶
func (*DestroyFlowResponse) ProtoMessage()
func (*DestroyFlowResponse) ProtoReflect ¶
func (x *DestroyFlowResponse) ProtoReflect() protoreflect.Message
func (*DestroyFlowResponse) Reset ¶
func (x *DestroyFlowResponse) Reset()
func (*DestroyFlowResponse) String ¶
func (x *DestroyFlowResponse) String() string
type Directory ¶ added in v0.1.125
type Directory struct {
// files are files or directories directly represented in this directory result.
Files []*FileInfo `protobuf:"bytes,1,rep,name=files,proto3" json:"files,omitempty"`
// contains filtered or unexported fields
}
Directory contains the entries discovered under one filesystem directory.
func (*Directory) Descriptor
deprecated
added in
v0.1.125
func (*Directory) ProtoMessage ¶ added in v0.1.125
func (*Directory) ProtoMessage()
func (*Directory) ProtoReflect ¶ added in v0.1.125
func (x *Directory) ProtoReflect() protoreflect.Message
type FileInfo ¶ added in v0.1.124
type FileInfo struct {
// path is a workspace- or service-relative filesystem path.
Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
// content is file content for regular files; empty for directories.
Content []byte `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
// is_directory is true when the path is a directory.
IsDirectory bool `protobuf:"varint,3,opt,name=is_directory,json=isDirectory,proto3" json:"is_directory,omitempty"`
// contains filtered or unexported fields
}
FileInfo carries a file or directory entry returned by CLI file helpers.
func (*FileInfo) Descriptor
deprecated
added in
v0.1.124
func (*FileInfo) GetContent ¶ added in v0.1.124
func (*FileInfo) GetIsDirectory ¶ added in v0.1.124
func (*FileInfo) ProtoMessage ¶ added in v0.1.124
func (*FileInfo) ProtoMessage()
func (*FileInfo) ProtoReflect ¶ added in v0.1.124
func (x *FileInfo) ProtoReflect() protoreflect.Message
type FlowStatus ¶
type FlowStatus struct {
// ready is true when the flow or service has reached an operable state.
Ready bool `protobuf:"varint,1,opt,name=ready,proto3" json:"ready,omitempty"`
// contains filtered or unexported fields
}
FlowStatus reports whether the current orchestration flow is ready.
func (*FlowStatus) Descriptor
deprecated
func (*FlowStatus) Descriptor() ([]byte, []int)
Deprecated: Use FlowStatus.ProtoReflect.Descriptor instead.
func (*FlowStatus) GetReady ¶
func (x *FlowStatus) GetReady() bool
func (*FlowStatus) ProtoMessage ¶
func (*FlowStatus) ProtoMessage()
func (*FlowStatus) ProtoReflect ¶
func (x *FlowStatus) ProtoReflect() protoreflect.Message
func (*FlowStatus) Reset ¶
func (x *FlowStatus) Reset()
func (*FlowStatus) String ¶
func (x *FlowStatus) String() string
type GetAddressRequest ¶
type GetAddressRequest struct {
// module is the Codefly module name that groups services.
Module string `protobuf:"bytes,1,opt,name=module,proto3" json:"module,omitempty"`
// service is the Codefly service name, optionally scoped by module in callers.
Service string `protobuf:"bytes,2,opt,name=service,proto3" json:"service,omitempty"`
// endpoint is the logical endpoint name declared by a service.
Endpoint string `protobuf:"bytes,3,opt,name=endpoint,proto3" json:"endpoint,omitempty"`
// contains filtered or unexported fields
}
GetAddressRequest identifies the concrete address for one service endpoint.
func (*GetAddressRequest) Descriptor
deprecated
func (*GetAddressRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetAddressRequest.ProtoReflect.Descriptor instead.
func (*GetAddressRequest) GetEndpoint ¶
func (x *GetAddressRequest) GetEndpoint() string
func (*GetAddressRequest) GetModule ¶
func (x *GetAddressRequest) GetModule() string
func (*GetAddressRequest) GetService ¶
func (x *GetAddressRequest) GetService() string
func (*GetAddressRequest) ProtoMessage ¶
func (*GetAddressRequest) ProtoMessage()
func (*GetAddressRequest) ProtoReflect ¶
func (x *GetAddressRequest) ProtoReflect() protoreflect.Message
func (*GetAddressRequest) Reset ¶
func (x *GetAddressRequest) Reset()
func (*GetAddressRequest) String ¶
func (x *GetAddressRequest) String() string
type GetAddressResponse ¶
type GetAddressResponse struct {
// address is the concrete host or URL callers should use.
Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
// contains filtered or unexported fields
}
GetAddressResponse returns the address selected for the caller's runtime context.
func (*GetAddressResponse) Descriptor
deprecated
func (*GetAddressResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetAddressResponse.ProtoReflect.Descriptor instead.
func (*GetAddressResponse) GetAddress ¶
func (x *GetAddressResponse) GetAddress() string
func (*GetAddressResponse) ProtoMessage ¶
func (*GetAddressResponse) ProtoMessage()
func (*GetAddressResponse) ProtoReflect ¶
func (x *GetAddressResponse) ProtoReflect() protoreflect.Message
func (*GetAddressResponse) Reset ¶
func (x *GetAddressResponse) Reset()
func (*GetAddressResponse) String ¶
func (x *GetAddressResponse) String() string
type GetAgentInformationRequest ¶
type GetAgentInformationRequest struct {
// agent is the agent name or reference, such as go-grpc or nextjs.
Agent string `protobuf:"bytes,1,opt,name=agent,proto3" json:"agent,omitempty"`
// contains filtered or unexported fields
}
GetAgentInformationRequest identifies an installed agent to inspect.
func (*GetAgentInformationRequest) Descriptor
deprecated
func (*GetAgentInformationRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetAgentInformationRequest.ProtoReflect.Descriptor instead.
func (*GetAgentInformationRequest) GetAgent ¶
func (x *GetAgentInformationRequest) GetAgent() string
func (*GetAgentInformationRequest) ProtoMessage ¶
func (*GetAgentInformationRequest) ProtoMessage()
func (*GetAgentInformationRequest) ProtoReflect ¶
func (x *GetAgentInformationRequest) ProtoReflect() protoreflect.Message
func (*GetAgentInformationRequest) Reset ¶
func (x *GetAgentInformationRequest) Reset()
func (*GetAgentInformationRequest) String ¶
func (x *GetAgentInformationRequest) String() string
type GetConfigurationRequest ¶
type GetConfigurationRequest struct {
// module is the Codefly module name that groups services.
Module string `protobuf:"bytes,1,opt,name=module,proto3" json:"module,omitempty"`
// service is the Codefly service name, optionally scoped by module in callers.
Service string `protobuf:"bytes,2,opt,name=service,proto3" json:"service,omitempty"`
// contains filtered or unexported fields
}
GetConfigurationRequest identifies service-scoped configuration in the active workspace.
func (*GetConfigurationRequest) Descriptor
deprecated
func (*GetConfigurationRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetConfigurationRequest.ProtoReflect.Descriptor instead.
func (*GetConfigurationRequest) GetModule ¶
func (x *GetConfigurationRequest) GetModule() string
func (*GetConfigurationRequest) GetService ¶
func (x *GetConfigurationRequest) GetService() string
func (*GetConfigurationRequest) ProtoMessage ¶
func (*GetConfigurationRequest) ProtoMessage()
func (*GetConfigurationRequest) ProtoReflect ¶
func (x *GetConfigurationRequest) ProtoReflect() protoreflect.Message
func (*GetConfigurationRequest) Reset ¶
func (x *GetConfigurationRequest) Reset()
func (*GetConfigurationRequest) String ¶
func (x *GetConfigurationRequest) String() string
type GetConfigurationResponse ¶
type GetConfigurationResponse struct {
// configuration is the service or workspace configuration payload.
Configuration *v01.Configuration `protobuf:"bytes,1,opt,name=configuration,proto3" json:"configuration,omitempty"`
// contains filtered or unexported fields
}
GetConfigurationResponse returns the configuration declared by a service.
func (*GetConfigurationResponse) Descriptor
deprecated
func (*GetConfigurationResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetConfigurationResponse.ProtoReflect.Descriptor instead.
func (*GetConfigurationResponse) GetConfiguration ¶
func (x *GetConfigurationResponse) GetConfiguration() *v01.Configuration
func (*GetConfigurationResponse) ProtoMessage ¶
func (*GetConfigurationResponse) ProtoMessage()
func (*GetConfigurationResponse) ProtoReflect ¶
func (x *GetConfigurationResponse) ProtoReflect() protoreflect.Message
func (*GetConfigurationResponse) Reset ¶
func (x *GetConfigurationResponse) Reset()
func (*GetConfigurationResponse) String ¶
func (x *GetConfigurationResponse) String() string
type GetConfigurationsResponse ¶
type GetConfigurationsResponse struct {
// configurations are configuration payloads exposed to a service.
Configurations []*v01.Configuration `protobuf:"bytes,1,rep,name=configurations,proto3" json:"configurations,omitempty"`
// contains filtered or unexported fields
}
GetConfigurationsResponse returns multiple configuration payloads for dependency/runtime flows.
func (*GetConfigurationsResponse) Descriptor
deprecated
func (*GetConfigurationsResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetConfigurationsResponse.ProtoReflect.Descriptor instead.
func (*GetConfigurationsResponse) GetConfigurations ¶
func (x *GetConfigurationsResponse) GetConfigurations() []*v01.Configuration
func (*GetConfigurationsResponse) ProtoMessage ¶
func (*GetConfigurationsResponse) ProtoMessage()
func (*GetConfigurationsResponse) ProtoReflect ¶
func (x *GetConfigurationsResponse) ProtoReflect() protoreflect.Message
func (*GetConfigurationsResponse) Reset ¶
func (x *GetConfigurationsResponse) Reset()
func (*GetConfigurationsResponse) String ¶
func (x *GetConfigurationsResponse) String() string
type GetNetworkMappingsRequest ¶ added in v0.1.123
type GetNetworkMappingsRequest struct {
// module is the Codefly module name that groups services.
Module string `protobuf:"bytes,1,opt,name=module,proto3" json:"module,omitempty"`
// service is the Codefly service name, optionally scoped by module in callers.
Service string `protobuf:"bytes,2,opt,name=service,proto3" json:"service,omitempty"`
// contains filtered or unexported fields
}
GetNetworkMappingsRequest identifies a service whose network mappings should be returned.
func (*GetNetworkMappingsRequest) Descriptor
deprecated
added in
v0.1.123
func (*GetNetworkMappingsRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetNetworkMappingsRequest.ProtoReflect.Descriptor instead.
func (*GetNetworkMappingsRequest) GetModule ¶ added in v0.1.123
func (x *GetNetworkMappingsRequest) GetModule() string
func (*GetNetworkMappingsRequest) GetService ¶ added in v0.1.123
func (x *GetNetworkMappingsRequest) GetService() string
func (*GetNetworkMappingsRequest) ProtoMessage ¶ added in v0.1.123
func (*GetNetworkMappingsRequest) ProtoMessage()
func (*GetNetworkMappingsRequest) ProtoReflect ¶ added in v0.1.123
func (x *GetNetworkMappingsRequest) ProtoReflect() protoreflect.Message
func (*GetNetworkMappingsRequest) Reset ¶ added in v0.1.123
func (x *GetNetworkMappingsRequest) Reset()
func (*GetNetworkMappingsRequest) String ¶ added in v0.1.123
func (x *GetNetworkMappingsRequest) String() string
type GetNetworkMappingsResponse ¶ added in v0.1.123
type GetNetworkMappingsResponse struct {
// network_mappings map logical endpoints to concrete network instances.
NetworkMappings []*v01.NetworkMapping `protobuf:"bytes,1,rep,name=network_mappings,json=networkMappings,proto3" json:"network_mappings,omitempty"`
// contains filtered or unexported fields
}
GetNetworkMappingsResponse returns concrete network instances for a service's endpoints.
func (*GetNetworkMappingsResponse) Descriptor
deprecated
added in
v0.1.123
func (*GetNetworkMappingsResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetNetworkMappingsResponse.ProtoReflect.Descriptor instead.
func (*GetNetworkMappingsResponse) GetNetworkMappings ¶ added in v0.1.123
func (x *GetNetworkMappingsResponse) GetNetworkMappings() []*v01.NetworkMapping
func (*GetNetworkMappingsResponse) ProtoMessage ¶ added in v0.1.123
func (*GetNetworkMappingsResponse) ProtoMessage()
func (*GetNetworkMappingsResponse) ProtoReflect ¶ added in v0.1.123
func (x *GetNetworkMappingsResponse) ProtoReflect() protoreflect.Message
func (*GetNetworkMappingsResponse) Reset ¶ added in v0.1.123
func (x *GetNetworkMappingsResponse) Reset()
func (*GetNetworkMappingsResponse) String ¶ added in v0.1.123
func (x *GetNetworkMappingsResponse) String() string
type ListTerminalsRequest ¶ added in v0.1.155
type ListTerminalsRequest struct {
// contains filtered or unexported fields
}
ListTerminalsRequest carries optional filters for listing terminals.
func (*ListTerminalsRequest) Descriptor
deprecated
added in
v0.1.155
func (*ListTerminalsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListTerminalsRequest.ProtoReflect.Descriptor instead.
func (*ListTerminalsRequest) ProtoMessage ¶ added in v0.1.155
func (*ListTerminalsRequest) ProtoMessage()
func (*ListTerminalsRequest) ProtoReflect ¶ added in v0.1.155
func (x *ListTerminalsRequest) ProtoReflect() protoreflect.Message
func (*ListTerminalsRequest) Reset ¶ added in v0.1.155
func (x *ListTerminalsRequest) Reset()
func (*ListTerminalsRequest) String ¶ added in v0.1.155
func (x *ListTerminalsRequest) String() string
type ListTerminalsResponse ¶ added in v0.1.155
type ListTerminalsResponse struct {
// terminals are currently active PTY sessions.
Terminals []*TerminalInfo `protobuf:"bytes,1,rep,name=terminals,proto3" json:"terminals,omitempty"`
// contains filtered or unexported fields
}
ListTerminalsResponse returns the active terminal sessions.
func (*ListTerminalsResponse) Descriptor
deprecated
added in
v0.1.155
func (*ListTerminalsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListTerminalsResponse.ProtoReflect.Descriptor instead.
func (*ListTerminalsResponse) GetTerminals ¶ added in v0.1.155
func (x *ListTerminalsResponse) GetTerminals() []*TerminalInfo
func (*ListTerminalsResponse) ProtoMessage ¶ added in v0.1.155
func (*ListTerminalsResponse) ProtoMessage()
func (*ListTerminalsResponse) ProtoReflect ¶ added in v0.1.155
func (x *ListTerminalsResponse) ProtoReflect() protoreflect.Message
func (*ListTerminalsResponse) Reset ¶ added in v0.1.155
func (x *ListTerminalsResponse) Reset()
func (*ListTerminalsResponse) String ¶ added in v0.1.155
func (x *ListTerminalsResponse) String() string
type MultiGraphResponse ¶
type MultiGraphResponse struct {
// graphs are architecture graphs, usually grouped by public module boundary.
Graphs []*v0.GraphResponse `protobuf:"bytes,1,rep,name=graphs,proto3" json:"graphs,omitempty"`
// contains filtered or unexported fields
}
MultiGraphResponse contains multiple architecture graphs returned by one CLI endpoint.
func (*MultiGraphResponse) Descriptor
deprecated
func (*MultiGraphResponse) Descriptor() ([]byte, []int)
Deprecated: Use MultiGraphResponse.ProtoReflect.Descriptor instead.
func (*MultiGraphResponse) GetGraphs ¶
func (x *MultiGraphResponse) GetGraphs() []*v0.GraphResponse
func (*MultiGraphResponse) ProtoMessage ¶
func (*MultiGraphResponse) ProtoMessage()
func (*MultiGraphResponse) ProtoReflect ¶
func (x *MultiGraphResponse) ProtoReflect() protoreflect.Message
func (*MultiGraphResponse) Reset ¶
func (x *MultiGraphResponse) Reset()
func (*MultiGraphResponse) String ¶
func (x *MultiGraphResponse) String() string
type OpenTerminalRequest ¶ added in v0.1.155
type OpenTerminalRequest struct {
// module optionally scopes the terminal working directory to a module.
Module string `protobuf:"bytes,1,opt,name=module,proto3" json:"module,omitempty"` // optional: scope to module
// service optionally scopes the terminal working directory to a service.
Service string `protobuf:"bytes,2,opt,name=service,proto3" json:"service,omitempty"` // optional: scope to service (cwd = service dir)
// shell is the command interpreter used for the terminal session.
Shell string `protobuf:"bytes,3,opt,name=shell,proto3" json:"shell,omitempty"` // optional: override shell (default: $SHELL)
// rows is the requested terminal height in character cells.
Rows uint32 `protobuf:"varint,4,opt,name=rows,proto3" json:"rows,omitempty"` // initial terminal size
// cols is the requested terminal width in character cells.
Cols uint32 `protobuf:"varint,5,opt,name=cols,proto3" json:"cols,omitempty"`
// contains filtered or unexported fields
}
OpenTerminalRequest describes the shell and workspace scope for a new terminal.
func (*OpenTerminalRequest) Descriptor
deprecated
added in
v0.1.155
func (*OpenTerminalRequest) Descriptor() ([]byte, []int)
Deprecated: Use OpenTerminalRequest.ProtoReflect.Descriptor instead.
func (*OpenTerminalRequest) GetCols ¶ added in v0.1.155
func (x *OpenTerminalRequest) GetCols() uint32
func (*OpenTerminalRequest) GetModule ¶ added in v0.1.155
func (x *OpenTerminalRequest) GetModule() string
func (*OpenTerminalRequest) GetRows ¶ added in v0.1.155
func (x *OpenTerminalRequest) GetRows() uint32
func (*OpenTerminalRequest) GetService ¶ added in v0.1.155
func (x *OpenTerminalRequest) GetService() string
func (*OpenTerminalRequest) GetShell ¶ added in v0.1.155
func (x *OpenTerminalRequest) GetShell() string
func (*OpenTerminalRequest) ProtoMessage ¶ added in v0.1.155
func (*OpenTerminalRequest) ProtoMessage()
func (*OpenTerminalRequest) ProtoReflect ¶ added in v0.1.155
func (x *OpenTerminalRequest) ProtoReflect() protoreflect.Message
func (*OpenTerminalRequest) Reset ¶ added in v0.1.155
func (x *OpenTerminalRequest) Reset()
func (*OpenTerminalRequest) String ¶ added in v0.1.155
func (x *OpenTerminalRequest) String() string
type OpenTerminalResponse ¶ added in v0.1.155
type OpenTerminalResponse struct {
// session_id identifies the terminal session for future Attach/Resize/Close calls.
SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
// shell is the command interpreter used for the terminal session.
Shell string `protobuf:"bytes,2,opt,name=shell,proto3" json:"shell,omitempty"`
// working_dir is the resolved filesystem directory backing the PTY.
WorkingDir string `protobuf:"bytes,3,opt,name=working_dir,json=workingDir,proto3" json:"working_dir,omitempty"`
// contains filtered or unexported fields
}
OpenTerminalResponse identifies the created terminal and its resolved working directory.
func (*OpenTerminalResponse) Descriptor
deprecated
added in
v0.1.155
func (*OpenTerminalResponse) Descriptor() ([]byte, []int)
Deprecated: Use OpenTerminalResponse.ProtoReflect.Descriptor instead.
func (*OpenTerminalResponse) GetSessionId ¶ added in v0.1.155
func (x *OpenTerminalResponse) GetSessionId() string
func (*OpenTerminalResponse) GetShell ¶ added in v0.1.155
func (x *OpenTerminalResponse) GetShell() string
func (*OpenTerminalResponse) GetWorkingDir ¶ added in v0.1.155
func (x *OpenTerminalResponse) GetWorkingDir() string
func (*OpenTerminalResponse) ProtoMessage ¶ added in v0.1.155
func (*OpenTerminalResponse) ProtoMessage()
func (*OpenTerminalResponse) ProtoReflect ¶ added in v0.1.155
func (x *OpenTerminalResponse) ProtoReflect() protoreflect.Message
func (*OpenTerminalResponse) Reset ¶ added in v0.1.155
func (x *OpenTerminalResponse) Reset()
func (*OpenTerminalResponse) String ¶ added in v0.1.155
func (x *OpenTerminalResponse) String() string
type ResizeTerminalRequest ¶ added in v0.1.155
type ResizeTerminalRequest struct {
// session_id identifies the terminal session to resize.
SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
// rows is the requested terminal height in character cells.
Rows uint32 `protobuf:"varint,2,opt,name=rows,proto3" json:"rows,omitempty"`
// cols is the requested terminal width in character cells.
Cols uint32 `protobuf:"varint,3,opt,name=cols,proto3" json:"cols,omitempty"`
// contains filtered or unexported fields
}
ResizeTerminalRequest changes the dimensions of an active terminal PTY.
func (*ResizeTerminalRequest) Descriptor
deprecated
added in
v0.1.155
func (*ResizeTerminalRequest) Descriptor() ([]byte, []int)
Deprecated: Use ResizeTerminalRequest.ProtoReflect.Descriptor instead.
func (*ResizeTerminalRequest) GetCols ¶ added in v0.1.155
func (x *ResizeTerminalRequest) GetCols() uint32
func (*ResizeTerminalRequest) GetRows ¶ added in v0.1.155
func (x *ResizeTerminalRequest) GetRows() uint32
func (*ResizeTerminalRequest) GetSessionId ¶ added in v0.1.155
func (x *ResizeTerminalRequest) GetSessionId() string
func (*ResizeTerminalRequest) ProtoMessage ¶ added in v0.1.155
func (*ResizeTerminalRequest) ProtoMessage()
func (*ResizeTerminalRequest) ProtoReflect ¶ added in v0.1.155
func (x *ResizeTerminalRequest) ProtoReflect() protoreflect.Message
func (*ResizeTerminalRequest) Reset ¶ added in v0.1.155
func (x *ResizeTerminalRequest) Reset()
func (*ResizeTerminalRequest) String ¶ added in v0.1.155
func (x *ResizeTerminalRequest) String() string
type ResizeTerminalResponse ¶ added in v0.1.155
type ResizeTerminalResponse struct {
// contains filtered or unexported fields
}
ResizeTerminalResponse acknowledges a terminal resize request.
func (*ResizeTerminalResponse) Descriptor
deprecated
added in
v0.1.155
func (*ResizeTerminalResponse) Descriptor() ([]byte, []int)
Deprecated: Use ResizeTerminalResponse.ProtoReflect.Descriptor instead.
func (*ResizeTerminalResponse) ProtoMessage ¶ added in v0.1.155
func (*ResizeTerminalResponse) ProtoMessage()
func (*ResizeTerminalResponse) ProtoReflect ¶ added in v0.1.155
func (x *ResizeTerminalResponse) ProtoReflect() protoreflect.Message
func (*ResizeTerminalResponse) Reset ¶ added in v0.1.155
func (x *ResizeTerminalResponse) Reset()
func (*ResizeTerminalResponse) String ¶ added in v0.1.155
func (x *ResizeTerminalResponse) String() string
type RunningInformation ¶
type RunningInformation struct {
// module is the Codefly module name that groups services.
Module string `protobuf:"bytes,1,opt,name=module,proto3" json:"module,omitempty"`
// service is the Codefly service name, optionally scoped by module in callers.
Service string `protobuf:"bytes,2,opt,name=service,proto3" json:"service,omitempty"`
// agent_pid is the operating-system process id of the agent process.
AgentPid int32 `protobuf:"varint,3,opt,name=agent_pid,json=agentPid,proto3" json:"agent_pid,omitempty"`
// contains filtered or unexported fields
}
RunningInformation reports an active service and the agent process handling it.
func (*RunningInformation) Descriptor
deprecated
func (*RunningInformation) Descriptor() ([]byte, []int)
Deprecated: Use RunningInformation.ProtoReflect.Descriptor instead.
func (*RunningInformation) GetAgentPid ¶
func (x *RunningInformation) GetAgentPid() int32
func (*RunningInformation) GetModule ¶
func (x *RunningInformation) GetModule() string
func (*RunningInformation) GetService ¶
func (x *RunningInformation) GetService() string
func (*RunningInformation) ProtoMessage ¶
func (*RunningInformation) ProtoMessage()
func (*RunningInformation) ProtoReflect ¶
func (x *RunningInformation) ProtoReflect() protoreflect.Message
func (*RunningInformation) Reset ¶
func (x *RunningInformation) Reset()
func (*RunningInformation) String ¶
func (x *RunningInformation) String() string
type StopFlowRequest ¶
type StopFlowRequest struct {
// contains filtered or unexported fields
}
StopFlowRequest asks the CLI to stop the active orchestration flow.
func (*StopFlowRequest) Descriptor
deprecated
func (*StopFlowRequest) Descriptor() ([]byte, []int)
Deprecated: Use StopFlowRequest.ProtoReflect.Descriptor instead.
func (*StopFlowRequest) ProtoMessage ¶
func (*StopFlowRequest) ProtoMessage()
func (*StopFlowRequest) ProtoReflect ¶
func (x *StopFlowRequest) ProtoReflect() protoreflect.Message
func (*StopFlowRequest) Reset ¶
func (x *StopFlowRequest) Reset()
func (*StopFlowRequest) String ¶
func (x *StopFlowRequest) String() string
type StopFlowResponse ¶
type StopFlowResponse struct {
// contains filtered or unexported fields
}
StopFlowResponse acknowledges that the active flow stop request was accepted.
func (*StopFlowResponse) Descriptor
deprecated
func (*StopFlowResponse) Descriptor() ([]byte, []int)
Deprecated: Use StopFlowResponse.ProtoReflect.Descriptor instead.
func (*StopFlowResponse) ProtoMessage ¶
func (*StopFlowResponse) ProtoMessage()
func (*StopFlowResponse) ProtoReflect ¶
func (x *StopFlowResponse) ProtoReflect() protoreflect.Message
func (*StopFlowResponse) Reset ¶
func (x *StopFlowResponse) Reset()
func (*StopFlowResponse) String ¶
func (x *StopFlowResponse) String() string
type TerminalInfo ¶ added in v0.1.155
type TerminalInfo struct {
// session_id identifies the terminal session.
SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
// shell is the command interpreter used for the terminal session.
Shell string `protobuf:"bytes,2,opt,name=shell,proto3" json:"shell,omitempty"`
// working_dir is an optional service-relative directory for command execution.
WorkingDir string `protobuf:"bytes,3,opt,name=working_dir,json=workingDir,proto3" json:"working_dir,omitempty"`
// module is the Codefly module name that groups services.
Module string `protobuf:"bytes,4,opt,name=module,proto3" json:"module,omitempty"`
// service is the Codefly service name, optionally scoped by module in callers.
Service string `protobuf:"bytes,5,opt,name=service,proto3" json:"service,omitempty"`
// contains filtered or unexported fields
}
TerminalInfo describes one active terminal session.
func (*TerminalInfo) Descriptor
deprecated
added in
v0.1.155
func (*TerminalInfo) Descriptor() ([]byte, []int)
Deprecated: Use TerminalInfo.ProtoReflect.Descriptor instead.
func (*TerminalInfo) GetModule ¶ added in v0.1.155
func (x *TerminalInfo) GetModule() string
func (*TerminalInfo) GetService ¶ added in v0.1.155
func (x *TerminalInfo) GetService() string
func (*TerminalInfo) GetSessionId ¶ added in v0.1.155
func (x *TerminalInfo) GetSessionId() string
func (*TerminalInfo) GetShell ¶ added in v0.1.155
func (x *TerminalInfo) GetShell() string
func (*TerminalInfo) GetWorkingDir ¶ added in v0.1.155
func (x *TerminalInfo) GetWorkingDir() string
func (*TerminalInfo) ProtoMessage ¶ added in v0.1.155
func (*TerminalInfo) ProtoMessage()
func (*TerminalInfo) ProtoReflect ¶ added in v0.1.155
func (x *TerminalInfo) ProtoReflect() protoreflect.Message
func (*TerminalInfo) Reset ¶ added in v0.1.155
func (x *TerminalInfo) Reset()
func (*TerminalInfo) String ¶ added in v0.1.155
func (x *TerminalInfo) String() string
type TerminalInput ¶ added in v0.1.155
type TerminalInput struct {
// session_id identifies the terminal session receiving the input.
SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
// data is the raw terminal, binary, or protocol payload.
Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"` // raw stdin bytes from client
// contains filtered or unexported fields
}
TerminalInput carries bytes written by the client to a terminal PTY.
func (*TerminalInput) Descriptor
deprecated
added in
v0.1.155
func (*TerminalInput) Descriptor() ([]byte, []int)
Deprecated: Use TerminalInput.ProtoReflect.Descriptor instead.
func (*TerminalInput) GetData ¶ added in v0.1.155
func (x *TerminalInput) GetData() []byte
func (*TerminalInput) GetSessionId ¶ added in v0.1.155
func (x *TerminalInput) GetSessionId() string
func (*TerminalInput) ProtoMessage ¶ added in v0.1.155
func (*TerminalInput) ProtoMessage()
func (*TerminalInput) ProtoReflect ¶ added in v0.1.155
func (x *TerminalInput) ProtoReflect() protoreflect.Message
func (*TerminalInput) Reset ¶ added in v0.1.155
func (x *TerminalInput) Reset()
func (*TerminalInput) String ¶ added in v0.1.155
func (x *TerminalInput) String() string
type TerminalOutput ¶ added in v0.1.155
type TerminalOutput struct {
// session_id identifies the terminal session that produced this output.
SessionId string `protobuf:"bytes,1,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
// data is the raw terminal, binary, or protocol payload.
Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"` // raw stdout/stderr bytes from PTY
// done is true when the terminal stream has completed.
Done bool `protobuf:"varint,3,opt,name=done,proto3" json:"done,omitempty"` // true when shell process exits
// exit_code is the process exit status returned by the operating system.
ExitCode int32 `protobuf:"varint,4,opt,name=exit_code,json=exitCode,proto3" json:"exit_code,omitempty"` // set when done=true
// contains filtered or unexported fields
}
TerminalOutput carries bytes emitted by a terminal PTY.
func (*TerminalOutput) Descriptor
deprecated
added in
v0.1.155
func (*TerminalOutput) Descriptor() ([]byte, []int)
Deprecated: Use TerminalOutput.ProtoReflect.Descriptor instead.
func (*TerminalOutput) GetData ¶ added in v0.1.155
func (x *TerminalOutput) GetData() []byte
func (*TerminalOutput) GetDone ¶ added in v0.1.155
func (x *TerminalOutput) GetDone() bool
func (*TerminalOutput) GetExitCode ¶ added in v0.1.155
func (x *TerminalOutput) GetExitCode() int32
func (*TerminalOutput) GetSessionId ¶ added in v0.1.155
func (x *TerminalOutput) GetSessionId() string
func (*TerminalOutput) ProtoMessage ¶ added in v0.1.155
func (*TerminalOutput) ProtoMessage()
func (*TerminalOutput) ProtoReflect ¶ added in v0.1.155
func (x *TerminalOutput) ProtoReflect() protoreflect.Message
func (*TerminalOutput) Reset ¶ added in v0.1.155
func (x *TerminalOutput) Reset()
func (*TerminalOutput) String ¶ added in v0.1.155
func (x *TerminalOutput) String() string
type TerminalServiceClient ¶ added in v0.1.155
type TerminalServiceClient interface {
// Open creates a new PTY-backed terminal session scoped to the requested workspace context.
Open(ctx context.Context, in *OpenTerminalRequest, opts ...grpc.CallOption) (*OpenTerminalResponse, error)
// Attach streams raw input bytes to the PTY and raw output bytes back to the client.
Attach(ctx context.Context, opts ...grpc.CallOption) (grpc.BidiStreamingClient[TerminalInput, TerminalOutput], error)
// Resize changes the PTY dimensions for an active terminal session.
Resize(ctx context.Context, in *ResizeTerminalRequest, opts ...grpc.CallOption) (*ResizeTerminalResponse, error)
// Close terminates an active terminal session.
Close(ctx context.Context, in *CloseTerminalRequest, opts ...grpc.CallOption) (*CloseTerminalResponse, error)
// List returns active terminal sessions known to the CLI server.
List(ctx context.Context, in *ListTerminalsRequest, opts ...grpc.CallOption) (*ListTerminalsResponse, error)
}
TerminalServiceClient is the client API for TerminalService 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.
TerminalService provides interactive terminal sessions scoped to workspace/module/service. Sessions persist across client disconnections in the server-backed terminal model. Attach() is bidirectional streaming — auto-upgrades to WebSocket via grpc-websocket-proxy.
func NewTerminalServiceClient ¶ added in v0.1.155
func NewTerminalServiceClient(cc grpc.ClientConnInterface) TerminalServiceClient
type TerminalServiceServer ¶ added in v0.1.155
type TerminalServiceServer interface {
// Open creates a new PTY-backed terminal session scoped to the requested workspace context.
Open(context.Context, *OpenTerminalRequest) (*OpenTerminalResponse, error)
// Attach streams raw input bytes to the PTY and raw output bytes back to the client.
Attach(grpc.BidiStreamingServer[TerminalInput, TerminalOutput]) error
// Resize changes the PTY dimensions for an active terminal session.
Resize(context.Context, *ResizeTerminalRequest) (*ResizeTerminalResponse, error)
// Close terminates an active terminal session.
Close(context.Context, *CloseTerminalRequest) (*CloseTerminalResponse, error)
// List returns active terminal sessions known to the CLI server.
List(context.Context, *ListTerminalsRequest) (*ListTerminalsResponse, error)
// contains filtered or unexported methods
}
TerminalServiceServer is the server API for TerminalService service. All implementations must embed UnimplementedTerminalServiceServer for forward compatibility.
TerminalService provides interactive terminal sessions scoped to workspace/module/service. Sessions persist across client disconnections in the server-backed terminal model. Attach() is bidirectional streaming — auto-upgrades to WebSocket via grpc-websocket-proxy.
type TerminalService_AttachClient ¶ added in v0.1.155
type TerminalService_AttachClient = grpc.BidiStreamingClient[TerminalInput, TerminalOutput]
This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
type TerminalService_AttachServer ¶ added in v0.1.155
type TerminalService_AttachServer = grpc.BidiStreamingServer[TerminalInput, TerminalOutput]
This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.
type UnimplementedCLIServer ¶
type UnimplementedCLIServer struct{}
UnimplementedCLIServer must be embedded to have forward compatible implementations.
NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.
func (UnimplementedCLIServer) ActiveLogHistory ¶
func (UnimplementedCLIServer) ActiveLogHistory(context.Context, *v02.LogRequest) (*v02.LogResponse, error)
func (UnimplementedCLIServer) DestroyFlow ¶
func (UnimplementedCLIServer) DestroyFlow(context.Context, *DestroyFlowRequest) (*DestroyFlowResponse, error)
func (UnimplementedCLIServer) GetActive ¶
func (UnimplementedCLIServer) GetActive(context.Context, *emptypb.Empty) (*ActiveResponse, error)
func (UnimplementedCLIServer) GetAddresses ¶
func (UnimplementedCLIServer) GetAddresses(context.Context, *GetAddressRequest) (*GetAddressResponse, error)
func (UnimplementedCLIServer) GetAgentInformation ¶
func (UnimplementedCLIServer) GetAgentInformation(context.Context, *GetAgentInformationRequest) (*v0.AgentInformation, error)
func (UnimplementedCLIServer) GetConfiguration ¶
func (UnimplementedCLIServer) GetConfiguration(context.Context, *GetConfigurationRequest) (*GetConfigurationResponse, error)
func (UnimplementedCLIServer) GetDependenciesConfigurations ¶
func (UnimplementedCLIServer) GetDependenciesConfigurations(context.Context, *GetConfigurationRequest) (*GetConfigurationsResponse, error)
func (UnimplementedCLIServer) GetDependenciesNetworkMappings ¶ added in v0.1.123
func (UnimplementedCLIServer) GetDependenciesNetworkMappings(context.Context, *GetNetworkMappingsRequest) (*GetNetworkMappingsResponse, error)
func (UnimplementedCLIServer) GetFlowStatus ¶
func (UnimplementedCLIServer) GetFlowStatus(context.Context, *emptypb.Empty) (*FlowStatus, error)
func (UnimplementedCLIServer) GetRuntimeConfigurations ¶
func (UnimplementedCLIServer) GetRuntimeConfigurations(context.Context, *GetConfigurationRequest) (*GetConfigurationsResponse, error)
func (UnimplementedCLIServer) GetWorkspaceInventory ¶
func (UnimplementedCLIServer) GetWorkspacePublicModulesDependencyGraph ¶
func (UnimplementedCLIServer) GetWorkspacePublicModulesDependencyGraph(context.Context, *emptypb.Empty) (*MultiGraphResponse, error)
func (UnimplementedCLIServer) GetWorkspaceServiceDependencyGraph ¶
func (UnimplementedCLIServer) GetWorkspaceServiceDependencyGraph(context.Context, *emptypb.Empty) (*v02.GraphResponse, error)
func (UnimplementedCLIServer) Logs ¶
func (UnimplementedCLIServer) Logs(*emptypb.Empty, grpc.ServerStreamingServer[v02.Log]) error
func (UnimplementedCLIServer) StopFlow ¶
func (UnimplementedCLIServer) StopFlow(context.Context, *StopFlowRequest) (*StopFlowResponse, error)
type UnimplementedTerminalServiceServer ¶ added in v0.1.155
type UnimplementedTerminalServiceServer struct{}
UnimplementedTerminalServiceServer must be embedded to have forward compatible implementations.
NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.
func (UnimplementedTerminalServiceServer) Close ¶ added in v0.1.155
func (UnimplementedTerminalServiceServer) Close(context.Context, *CloseTerminalRequest) (*CloseTerminalResponse, error)
func (UnimplementedTerminalServiceServer) List ¶ added in v0.1.155
func (UnimplementedTerminalServiceServer) List(context.Context, *ListTerminalsRequest) (*ListTerminalsResponse, error)
func (UnimplementedTerminalServiceServer) Open ¶ added in v0.1.155
func (UnimplementedTerminalServiceServer) Open(context.Context, *OpenTerminalRequest) (*OpenTerminalResponse, error)
func (UnimplementedTerminalServiceServer) Resize ¶ added in v0.1.155
func (UnimplementedTerminalServiceServer) Resize(context.Context, *ResizeTerminalRequest) (*ResizeTerminalResponse, error)
type UnsafeCLIServer ¶
type UnsafeCLIServer interface {
// contains filtered or unexported methods
}
UnsafeCLIServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to CLIServer will result in compilation errors.
type UnsafeTerminalServiceServer ¶ added in v0.1.155
type UnsafeTerminalServiceServer interface {
// contains filtered or unexported methods
}
UnsafeTerminalServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to TerminalServiceServer will result in compilation errors.