runnerv2alpha1

type CommandMode int32

type CreateSessionRequest struct {

	// metadata is a map of client specific metadata.
	Metadata map[string]string `` /* 157-byte string literal not displayed */
	// env field provides an initial set of environment variables
	// for a newly created session.
	Env []string `protobuf:"bytes,2,rep,name=env,proto3" json:"env,omitempty"`
	// project from which to load environment variables.
	// They will be appended to the list from the env field.
	// The env field has a higher priority.
	Project *Project `protobuf:"bytes,3,opt,name=project,proto3,oneof" json:"project,omitempty"`
	// contains filtered or unexported fields
}

type CreateSessionResponse struct {
	Session *Session `protobuf:"bytes,1,opt,name=session,proto3" json:"session,omitempty"`
	// contains filtered or unexported fields
}

type DeleteSessionRequest struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

type DeleteSessionResponse struct {
	// contains filtered or unexported fields
}

type ExecuteRequest struct {
	Config *ProgramConfig `protobuf:"bytes,1,opt,name=config,proto3" json:"config,omitempty"`
	// input_data is a byte array that will be send as input
	// to the program.
	InputData []byte `protobuf:"bytes,8,opt,name=input_data,json=inputData,proto3" json:"input_data,omitempty"`
	// stop requests the running process to be stopped.
	// It is allowed only in the consecutive calls.
	Stop ExecuteStop `protobuf:"varint,9,opt,name=stop,proto3,enum=runme.runner.v2alpha1.ExecuteStop" json:"stop,omitempty"`
	// sets pty winsize
	// has no effect in non-interactive mode
	Winsize *Winsize `protobuf:"bytes,10,opt,name=winsize,proto3,oneof" json:"winsize,omitempty"`
	// session_id indicates in which Session the program should execute.
	// Executing in a Session might provide additional context like
	// environment variables.
	SessionId string `protobuf:"bytes,20,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	// session_strategy is a strategy for selecting the session.
	SessionStrategy SessionStrategy `` /* 151-byte string literal not displayed */
	// project used to load environment variables from .env files.
	Project *Project `protobuf:"bytes,22,opt,name=project,proto3,oneof" json:"project,omitempty"`
	// store_stdout_in_env, if true, will store the stdout under well known name
	// and the last ran block in the environment variable `__`.
	StoreStdoutInEnv bool `protobuf:"varint,23,opt,name=store_stdout_in_env,json=storeStdoutInEnv,proto3" json:"store_stdout_in_env,omitempty"`
	// contains filtered or unexported fields
}

type ExecuteResponse struct {

	// exit_code is sent only in the final message.
	ExitCode *wrapperspb.UInt32Value `protobuf:"bytes,1,opt,name=exit_code,json=exitCode,proto3" json:"exit_code,omitempty"`
	// stdout_data contains bytes from stdout since the last response.
	StdoutData []byte `protobuf:"bytes,2,opt,name=stdout_data,json=stdoutData,proto3" json:"stdout_data,omitempty"`
	// stderr_data contains bytes from stderr since the last response.
	StderrData []byte `protobuf:"bytes,3,opt,name=stderr_data,json=stderrData,proto3" json:"stderr_data,omitempty"`
	// pid contains the process' PID.
	//
	// This is only sent once in an initial response for background processes.
	Pid *wrapperspb.UInt32Value `protobuf:"bytes,4,opt,name=pid,proto3" json:"pid,omitempty"`
	// mime_type is a detected MIME type of the stdout_data.
	//
	// This is only sent once in the first response containing stdout_data.
	MimeType string `protobuf:"bytes,5,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// contains filtered or unexported fields
}

type ExecuteStop int32

type GetSessionRequest struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

type GetSessionResponse struct {
	Session *Session `protobuf:"bytes,1,opt,name=session,proto3" json:"session,omitempty"`
	// contains filtered or unexported fields
}

type ListSessionsRequest struct {
	// contains filtered or unexported fields
}

type ListSessionsResponse struct {
	Sessions []*Session `protobuf:"bytes,1,rep,name=sessions,proto3" json:"sessions,omitempty"`
	// contains filtered or unexported fields
}

type ProgramConfig struct {

	// program_name is a name of the program to execute.
	// If it's not a path (relative or absolute), the runner
	// will try to resolve the name.
	// For example: "sh", "/bin/bash".
	ProgramName string `protobuf:"bytes,1,opt,name=program_name,json=programName,proto3" json:"program_name,omitempty"`
	// arguments is a list of arguments passed to the program.
	Arguments []string `protobuf:"bytes,2,rep,name=arguments,proto3" json:"arguments,omitempty"`
	// directory to execute the program in.
	Directory string `protobuf:"bytes,3,opt,name=directory,proto3" json:"directory,omitempty"`
	// env is a list of additional environment variables
	// that will be injected to the executed program.
	Env []string `protobuf:"bytes,4,rep,name=env,proto3" json:"env,omitempty"`
	// Types that are assignable to Source:
	//
	//	*ProgramConfig_Commands
	//	*ProgramConfig_Script
	Source isProgramConfig_Source `protobuf_oneof:"source"`
	// interactive, if true, uses a pseudo-tty to execute the program.
	// Otherwise, the program is executed using in-memory buffers for I/O.
	Interactive bool `protobuf:"varint,7,opt,name=interactive,proto3" json:"interactive,omitempty"`
	// TODO(adamb): understand motivation for this. In theory, source
	// should tell whether to execute it inline or as a file.
	Mode CommandMode `protobuf:"varint,8,opt,name=mode,proto3,enum=runme.runner.v2alpha1.CommandMode" json:"mode,omitempty"`
	// optional well known id for cell/block
	KnownId string `protobuf:"bytes,9,opt,name=known_id,json=knownId,proto3" json:"known_id,omitempty"`
	// optional well known name for cell/block
	KnownName string `protobuf:"bytes,10,opt,name=known_name,json=knownName,proto3" json:"known_name,omitempty"`
	// contains filtered or unexported fields
}

type ProgramConfig_CommandList struct {

	// commands are commands to be executed by the program.
	// The commands are joined and executed as a script.
	// For example: ["echo 'Hello, World'", "ls -l /etc"].
	Items []string `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

type ProgramConfig_Commands struct {
	// commands are commands to be executed by the program.
	// The commands are joined and executed as a script.
	Commands *ProgramConfig_CommandList `protobuf:"bytes,5,opt,name=commands,proto3,oneof"`
}

type ProgramConfig_Script struct {
	// script is code to be executed by the program.
	// Individual lines are joined with the new line character.
	Script string `protobuf:"bytes,6,opt,name=script,proto3,oneof"`
}

type Project struct {

	// root is a root directory of the project.
	// The semantic is the same as for the "--project"
	// flag in "runme".
	Root string `protobuf:"bytes,1,opt,name=root,proto3" json:"root,omitempty"`
	// env_load_order is list of environment files
	// to try and load env from.
	EnvLoadOrder []string `protobuf:"bytes,2,rep,name=env_load_order,json=envLoadOrder,proto3" json:"env_load_order,omitempty"`
	// contains filtered or unexported fields
}

type ResolveProgramCommandList struct {

	// commands are commands to be executed by the program.
	// The commands are joined and executed as a script.
	// For example: ["echo 'Hello, World'", "ls -l /etc"].
	Lines []string `protobuf:"bytes,1,rep,name=lines,proto3" json:"lines,omitempty"`
	// contains filtered or unexported fields
}

type ResolveProgramRequest struct {

	// use script for unnormalized cell content
	// whereas commands is for normalized shell commands
	//
	// Types that are assignable to Source:
	//
	//	*ResolveProgramRequest_Commands
	//	*ResolveProgramRequest_Script
	Source isResolveProgramRequest_Source `protobuf_oneof:"source"`
	// mode determines how variables resolution occurs.
	// It is usually based on document or cell annotation config.
	Mode ResolveProgramRequest_Mode `protobuf:"varint,3,opt,name=mode,proto3,enum=runme.runner.v2alpha1.ResolveProgramRequest_Mode" json:"mode,omitempty"`
	// env is a list of explicit environment variables that will be used
	// to resolve the environment variables found in the source.
	Env []string `protobuf:"bytes,4,rep,name=env,proto3" json:"env,omitempty"`
	// session_id indicates which session is the source of
	// environment variables. If not provided, the most recent
	// session can be used using session_strategy.
	SessionId string `protobuf:"bytes,5,opt,name=session_id,json=sessionId,proto3" json:"session_id,omitempty"`
	// session_strategy is a strategy for selecting the session.
	SessionStrategy SessionStrategy `` /* 150-byte string literal not displayed */
	// project used to load environment variables from .env files.
	Project *Project `protobuf:"bytes,7,opt,name=project,proto3,oneof" json:"project,omitempty"`
	// contains filtered or unexported fields
}

type ResolveProgramRequest_Commands struct {
	// commands are commands to be executed by the program.
	// The commands are joined and executed as a script.
	Commands *ResolveProgramCommandList `protobuf:"bytes,1,opt,name=commands,proto3,oneof"`
}

type ResolveProgramRequest_Mode int32

type ResolveProgramRequest_Script struct {
	// script is code to be executed by the program.
	// Individual lines are joined with the new line character.
	Script string `protobuf:"bytes,2,opt,name=script,proto3,oneof"`
}

type ResolveProgramResponse struct {
	Script string `protobuf:"bytes,1,opt,name=script,proto3" json:"script,omitempty"`
	// use script until commands normalization is implemented
	Commands *ResolveProgramCommandList          `protobuf:"bytes,2,opt,name=commands,proto3" json:"commands,omitempty"`
	Vars     []*ResolveProgramResponse_VarResult `protobuf:"bytes,3,rep,name=vars,proto3" json:"vars,omitempty"`
	// contains filtered or unexported fields
}

type ResolveProgramResponse_Status int32

type ResolveProgramResponse_VarResult struct {

	// prompt indicates the resolution status of the env variable.
	Status ResolveProgramResponse_Status `protobuf:"varint,1,opt,name=status,proto3,enum=runme.runner.v2alpha1.ResolveProgramResponse_Status" json:"status,omitempty"`
	// name is the name of the environment variable.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// original_value is a default value of the environment variable.
	// It might be a value that is assigned to the variable in the script,
	// like FOO=bar or FOO=${FOO:-bar}.
	// If the variable is not assigned, it is an empty string.
	OriginalValue string `protobuf:"bytes,3,opt,name=original_value,json=originalValue,proto3" json:"original_value,omitempty"`
	// resolved_value is a value of the environment variable resolved from a source.
	// If it is an empty string, it means that the environment variable is not resolved.
	ResolvedValue string `protobuf:"bytes,4,opt,name=resolved_value,json=resolvedValue,proto3" json:"resolved_value,omitempty"`
	// contains filtered or unexported fields
}

type RunnerServiceClient interface {
	CreateSession(ctx context.Context, in *CreateSessionRequest, opts ...grpc.CallOption) (*CreateSessionResponse, error)
	GetSession(ctx context.Context, in *GetSessionRequest, opts ...grpc.CallOption) (*GetSessionResponse, error)
	ListSessions(ctx context.Context, in *ListSessionsRequest, opts ...grpc.CallOption) (*ListSessionsResponse, error)
	UpdateSession(ctx context.Context, in *UpdateSessionRequest, opts ...grpc.CallOption) (*UpdateSessionResponse, error)
	DeleteSession(ctx context.Context, in *DeleteSessionRequest, opts ...grpc.CallOption) (*DeleteSessionResponse, error)
	// Execute executes a program. Examine "ExecuteRequest" to explore
	// configuration options.
	//
	// It's a bidirectional stream RPC method. It expects the first
	// "ExecuteRequest" to contain details of a program to execute.
	// Subsequent "ExecuteRequest" should only contain "input_data" as
	// other fields will be ignored.
	Execute(ctx context.Context, opts ...grpc.CallOption) (RunnerService_ExecuteClient, error)
	// ResolveProgram resolves variables from a script or a list of commands
	// using the provided sources, which can be a list of environment variables,
	// a session, or a project.
	// For now, the resolved variables are only the exported ones using `export`.
	ResolveProgram(ctx context.Context, in *ResolveProgramRequest, opts ...grpc.CallOption) (*ResolveProgramResponse, error)
}

type RunnerServiceServer interface {
	CreateSession(context.Context, *CreateSessionRequest) (*CreateSessionResponse, error)
	GetSession(context.Context, *GetSessionRequest) (*GetSessionResponse, error)
	ListSessions(context.Context, *ListSessionsRequest) (*ListSessionsResponse, error)
	UpdateSession(context.Context, *UpdateSessionRequest) (*UpdateSessionResponse, error)
	DeleteSession(context.Context, *DeleteSessionRequest) (*DeleteSessionResponse, error)
	// Execute executes a program. Examine "ExecuteRequest" to explore
	// configuration options.
	//
	// It's a bidirectional stream RPC method. It expects the first
	// "ExecuteRequest" to contain details of a program to execute.
	// Subsequent "ExecuteRequest" should only contain "input_data" as
	// other fields will be ignored.
	Execute(RunnerService_ExecuteServer) error
	// ResolveProgram resolves variables from a script or a list of commands
	// using the provided sources, which can be a list of environment variables,
	// a session, or a project.
	// For now, the resolved variables are only the exported ones using `export`.
	ResolveProgram(context.Context, *ResolveProgramRequest) (*ResolveProgramResponse, error)
	// contains filtered or unexported methods
}

type RunnerService_ExecuteClient interface {
	Send(*ExecuteRequest) error
	Recv() (*ExecuteResponse, error)
	grpc.ClientStream
}

type RunnerService_ExecuteServer interface {
	Send(*ExecuteResponse) error
	Recv() (*ExecuteRequest, error)
	grpc.ServerStream
}

type Session struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// env keeps track of session environment variables.
	// They can be modified by executing programs which
	// alter them through "export" and "unset" commands.
	Env []string `protobuf:"bytes,2,rep,name=env,proto3" json:"env,omitempty"`
	// metadata is a map of client specific metadata.
	Metadata map[string]string `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

type SessionStrategy int32

type UnimplementedRunnerServiceServer struct {
}

type UnsafeRunnerServiceServer interface {
	// contains filtered or unexported methods
}

type UpdateSessionRequest struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// metadata is a map of client specific metadata.
	Metadata map[string]string `` /* 157-byte string literal not displayed */
	// env field provides an initial set of environment variables
	// for a newly created session.
	Env []string `protobuf:"bytes,3,rep,name=env,proto3" json:"env,omitempty"`
	// project from which to load environment variables.
	// They will be appended to the list from the env field.
	// The env field has a higher priority.
	Project *Project `protobuf:"bytes,4,opt,name=project,proto3,oneof" json:"project,omitempty"`
	// contains filtered or unexported fields
}

type UpdateSessionResponse struct {
	Session *Session `protobuf:"bytes,1,opt,name=session,proto3" json:"session,omitempty"`
	// contains filtered or unexported fields
}

type Winsize struct {
	Rows uint32 `protobuf:"varint,1,opt,name=rows,proto3" json:"rows,omitempty"`
	Cols uint32 `protobuf:"varint,2,opt,name=cols,proto3" json:"cols,omitempty"`
	X    uint32 `protobuf:"varint,3,opt,name=x,proto3" json:"x,omitempty"`
	Y    uint32 `protobuf:"varint,4,opt,name=y,proto3" json:"y,omitempty"`
	// contains filtered or unexported fields
}