pluginv1alpha

type BackendPluginClient interface {
	// Capabilities returns the backend's identity, filesystem layout, and the one
	// feature flag the runner needs. Called once at connection time.
	Capabilities(ctx context.Context, in *CapabilitiesRequest, opts ...grpc.CallOption) (*CapabilitiesResponse, error)
	// Create provisions a new execution environment. Service containers are
	// passed here so the backend realises them however fits its platform.
	Create(ctx context.Context, in *CreateRequest, opts ...grpc.CallOption) (*CreateResponse, error)
	// Start boots a previously created environment.
	//
	// Start implementations should detect when the RPC stream is terminated
	// externally before the command completes, as this will signal explicit job
	// cancellation, or job timeout. When detected, the implementation should
	// terminate the startup process on the environment. The Remove RPC for the
	// environment will follow, even though the Start RPC did not complete.
	Start(ctx context.Context, in *StartRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[StartOutput], error)
	// Exec runs a command inside the environment, streaming stdout/stderr back.
	//
	// Exec implementations should detect when the RPC stream is terminated
	// externally before the command completes, as this will signal explicit job
	// cancellation, job timeout, or command timeout. When detected, the
	// implementation should terminate the running command on the
	// environment. Implementation should not rely on a failed write to the
	// output stream as its cancellation signal as some commands produce
	// infrequent output. (Implementation note: observing context cancellation in
	// Go, a cancellation-aware select on the response channel in Rust's
	// `tokio::sync::mspc::Sender::closed()`, or a server-side cancellation
	// callback in Python/Java.)
	Exec(ctx context.Context, in *ExecRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[ExecOutput], error)
	// CopyIn transfers a tar archive into the environment.
	CopyIn(ctx context.Context, opts ...grpc.CallOption) (grpc.ClientStreamingClient[CopyInChunk, CopyInResponse], error)
	// CopyOut transfers a tar archive out of the environment. The runner reads
	// env files (GITHUB_ENV/OUTPUT/STATE) back this way and parses them itself.
	CopyOut(ctx context.Context, in *CopyOutRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[CopyOutChunk], error)
	// Remove tears down the environment and releases its resources.
	Remove(ctx context.Context, in *RemoveRequest, opts ...grpc.CallOption) (*RemoveResponse, error)
}

type BackendPluginServer interface {
	// Capabilities returns the backend's identity, filesystem layout, and the one
	// feature flag the runner needs. Called once at connection time.
	Capabilities(context.Context, *CapabilitiesRequest) (*CapabilitiesResponse, error)
	// Create provisions a new execution environment. Service containers are
	// passed here so the backend realises them however fits its platform.
	Create(context.Context, *CreateRequest) (*CreateResponse, error)
	// Start boots a previously created environment.
	//
	// Start implementations should detect when the RPC stream is terminated
	// externally before the command completes, as this will signal explicit job
	// cancellation, or job timeout. When detected, the implementation should
	// terminate the startup process on the environment. The Remove RPC for the
	// environment will follow, even though the Start RPC did not complete.
	Start(*StartRequest, grpc.ServerStreamingServer[StartOutput]) error
	// Exec runs a command inside the environment, streaming stdout/stderr back.
	//
	// Exec implementations should detect when the RPC stream is terminated
	// externally before the command completes, as this will signal explicit job
	// cancellation, job timeout, or command timeout. When detected, the
	// implementation should terminate the running command on the
	// environment. Implementation should not rely on a failed write to the
	// output stream as its cancellation signal as some commands produce
	// infrequent output. (Implementation note: observing context cancellation in
	// Go, a cancellation-aware select on the response channel in Rust's
	// `tokio::sync::mspc::Sender::closed()`, or a server-side cancellation
	// callback in Python/Java.)
	Exec(*ExecRequest, grpc.ServerStreamingServer[ExecOutput]) error
	// CopyIn transfers a tar archive into the environment.
	CopyIn(grpc.ClientStreamingServer[CopyInChunk, CopyInResponse]) error
	// CopyOut transfers a tar archive out of the environment. The runner reads
	// env files (GITHUB_ENV/OUTPUT/STATE) back this way and parses them itself.
	CopyOut(*CopyOutRequest, grpc.ServerStreamingServer[CopyOutChunk]) error
	// Remove tears down the environment and releases its resources.
	Remove(context.Context, *RemoveRequest) (*RemoveResponse, error)
	// contains filtered or unexported methods
}

type BackendPlugin_CopyInClient = grpc.ClientStreamingClient[CopyInChunk, CopyInResponse]

type BackendPlugin_CopyInServer = grpc.ClientStreamingServer[CopyInChunk, CopyInResponse]

type BackendPlugin_CopyOutClient = grpc.ServerStreamingClient[CopyOutChunk]

type BackendPlugin_CopyOutServer = grpc.ServerStreamingServer[CopyOutChunk]

type BackendPlugin_ExecClient = grpc.ServerStreamingClient[ExecOutput]

type BackendPlugin_ExecServer = grpc.ServerStreamingServer[ExecOutput]

type BackendPlugin_StartClient = grpc.ServerStreamingClient[StartOutput]

type BackendPlugin_StartServer = grpc.ServerStreamingServer[StartOutput]

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

type CapabilitiesResponse struct {

	// name identifies the backend (e.g. "kubernetes"); used in logs and as the
	// container back-end name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

type CopyInChunk struct {
	EnvironmentId *string `protobuf:"bytes,1,opt,name=environment_id,json=environmentId,proto3,oneof" json:"environment_id,omitempty"`
	// dest_path is the directory the tar archive is extracted into. The plugin
	// must ensure that the destination folder exists in the target environment
	// before extracting the incoming data stream.
	DestPath *string `protobuf:"bytes,2,opt,name=dest_path,json=destPath,proto3,oneof" json:"dest_path,omitempty"`
	// data is a chunk of the tar archive.
	Data []byte `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

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

type CopyOutChunk struct {

	// data is a chunk of the tar archive.
	Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

type CopyOutRequest struct {
	EnvironmentId string `protobuf:"bytes,1,opt,name=environment_id,json=environmentId,proto3" json:"environment_id,omitempty"`
	// src_path is the path inside the environment to archive and stream out.
	SrcPath string `protobuf:"bytes,2,opt,name=src_path,json=srcPath,proto3" json:"src_path,omitempty"`
	// contains filtered or unexported fields
}

type CreateRequest struct {

	// image is the backend-defined reference for the job container image, opaque
	// to the protocol (a Docker image name, a VM template, ...).
	Image string `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"`
	// name is a runner-assigned handle for the environment, unique per job.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// cap_add / cap_drop are advisory Linux capability adjustments; backends that
	// cannot apply them ignore them.
	CapAdd  []string `protobuf:"bytes,5,rep,name=cap_add,json=capAdd,proto3" json:"cap_add,omitempty"`
	CapDrop []string `protobuf:"bytes,6,rep,name=cap_drop,json=capDrop,proto3" json:"cap_drop,omitempty"`
	// services are the service containers to bring up alongside the job.
	Services []*ServiceContainer `protobuf:"bytes,7,rep,name=services,proto3" json:"services,omitempty"`
	// backend_options are opaque, backend-specific options taken verbatim from
	// the runner's per-label plugin configuration (e.g. namespace, VM flavour).
	BackendOptions map[string]string `` /* 177-byte string literal not displayed */
	// label_arg is the optional suffix of the runs-on plugin label.
	LabelArg string `protobuf:"bytes,9,opt,name=label_arg,json=labelArg,proto3" json:"label_arg,omitempty"`
	// environment_timeout limits the lifetime of this execution environment.
	EnvironmentTimeout *durationpb.Duration `protobuf:"bytes,10,opt,name=environment_timeout,json=environmentTimeout,proto3" json:"environment_timeout,omitempty"`
	// contains filtered or unexported fields
}

type CreateResponse struct {

	// environment_id is the handle for all later RPCs targeting this environment.
	EnvironmentId string `protobuf:"bytes,1,opt,name=environment_id,json=environmentId,proto3" json:"environment_id,omitempty"`
	// root_path is the base directory the runner lays workflow files out
	// under.
	RootPath string `protobuf:"bytes,2,opt,name=root_path,json=rootPath,proto3" json:"root_path,omitempty"`
	// act_path is the directory where the runner stages its helper binaries and
	// action code.
	ActPath string `protobuf:"bytes,3,opt,name=act_path,json=actPath,proto3" json:"act_path,omitempty"`
	// tool_cache_path is exposed to jobs as RUNNER_TOOL_CACHE.
	ToolCachePath string `protobuf:"bytes,4,opt,name=tool_cache_path,json=toolCachePath,proto3" json:"tool_cache_path,omitempty"`
	// temp_path is exposed to jobs as RUNNER_TEMP.
	TempPath string `protobuf:"bytes,5,opt,name=temp_path,json=tempPath,proto3" json:"temp_path,omitempty"`
	// path_variable_name is the search-path environment variable; the runner uses
	// "PATH" when unset.
	PathVariableName *string `protobuf:"bytes,6,opt,name=path_variable_name,json=pathVariableName,proto3,oneof" json:"path_variable_name,omitempty"`
	// default_path_variable is the search path used when a job sets none.
	DefaultPathVariable *string `` /* 126-byte string literal not displayed */
	// path_separator joins path entries; the runner uses ":" when unset.
	PathSeparator *string `protobuf:"bytes,8,opt,name=path_separator,json=pathSeparator,proto3,oneof" json:"path_separator,omitempty"`
	// environment_case_insensitive marks environments whose variable names are
	// case-insensitive (Windows), so the runner de-duplicates accordingly.
	EnvironmentCaseInsensitive bool `` /* 142-byte string literal not displayed */
	// os populates the RUNNER_OS environment variable exposed to the job.
	Os string `protobuf:"bytes,10,opt,name=os,proto3" json:"os,omitempty"`
	// arch populates the RUNNER_ARCH environment variable exposed to the job.
	Arch string `protobuf:"bytes,11,opt,name=arch,proto3" json:"arch,omitempty"`
	// contains filtered or unexported fields
}

type DataChunk struct {

	// stream identifies which output data belongs to.
	Stream DataChunk_Stream `protobuf:"varint,1,opt,name=stream,proto3,enum=plugin.v1alpha.DataChunk_Stream" json:"stream,omitempty"`
	// data is a chunk of output bytes.
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

type DataChunk_Stream int32

type ExecComplete struct {

	// exit_code is the command's exit status; only set on the final message.
	ExitCode int32 `protobuf:"varint,1,opt,name=exit_code,json=exitCode,proto3" json:"exit_code,omitempty"`
	// contains filtered or unexported fields
}

type ExecFailed struct {

	// error_message describes a failure to run the command (as opposed to the
	// command failing); only set on the final message.
	ErrorMessage string `protobuf:"bytes,1,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// contains filtered or unexported fields
}

type ExecOutput struct {

	// Types that are valid to be assigned to Output:
	//
	//	*ExecOutput_Data
	//	*ExecOutput_ExecComplete
	//	*ExecOutput_ExecFailed
	Output isExecOutput_Output `protobuf_oneof:"Output"`
	// contains filtered or unexported fields
}

type ExecOutput_Data struct {
	Data *DataChunk `protobuf:"bytes,1,opt,name=data,proto3,oneof"`
}

type ExecOutput_ExecComplete struct {
	ExecComplete *ExecComplete `protobuf:"bytes,2,opt,name=exec_complete,json=execComplete,proto3,oneof"`
}

type ExecOutput_ExecFailed struct {
	ExecFailed *ExecFailed `protobuf:"bytes,3,opt,name=exec_failed,json=execFailed,proto3,oneof"`
}

type ExecRequest struct {
	EnvironmentId string `protobuf:"bytes,1,opt,name=environment_id,json=environmentId,proto3" json:"environment_id,omitempty"`
	// command is the argv to run; command[0] is the executable.
	Command []string `protobuf:"bytes,2,rep,name=command,proto3" json:"command,omitempty"`
	// env are environment variables to set for this command.
	Env map[string]string `` /* 133-byte string literal not displayed */
	// user is the user to run as; the backend's default is used when unset.
	User *string `protobuf:"bytes,4,opt,name=user,proto3,oneof" json:"user,omitempty"`
	// workdir overrides the working directory for this command; the environment's
	// default is used when unset.
	Workdir string `protobuf:"bytes,5,opt,name=workdir,proto3" json:"workdir,omitempty"`
	// contains filtered or unexported fields
}

type RemoveRequest struct {
	EnvironmentId string `protobuf:"bytes,1,opt,name=environment_id,json=environmentId,proto3" json:"environment_id,omitempty"`
	// contains filtered or unexported fields
}

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

type ServiceContainer struct {

	// name is the service ID from the workflow `services:` block.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// image is the backend-defined image reference for the service.
	Image string `protobuf:"bytes,2,opt,name=image,proto3" json:"image,omitempty"`
	// env are the service container's environment variables.
	Env map[string]string `` /* 133-byte string literal not displayed */
	// ports are host:container port mappings requested for the service.
	Ports []string `protobuf:"bytes,4,rep,name=ports,proto3" json:"ports,omitempty"`
	// contains filtered or unexported fields
}

type StartComplete struct {

	// image_env are environment variables baked into the resolved image (e.g. a
	// Docker image's ENV). The runner layers them under the job's own variables.
	ImageEnv map[string]string `` /* 159-byte string literal not displayed */
	// contains filtered or unexported fields
}

type StartOutput struct {

	// Types that are valid to be assigned to Output:
	//
	//	*StartOutput_Data
	//	*StartOutput_StartComplete
	Output isStartOutput_Output `protobuf_oneof:"Output"`
	// contains filtered or unexported fields
}

type StartOutput_Data struct {
	Data *DataChunk `protobuf:"bytes,1,opt,name=data,proto3,oneof"`
}

type StartOutput_StartComplete struct {
	StartComplete *StartComplete `protobuf:"bytes,2,opt,name=start_complete,json=startComplete,proto3,oneof"`
}

type StartRequest struct {
	EnvironmentId string `protobuf:"bytes,1,opt,name=environment_id,json=environmentId,proto3" json:"environment_id,omitempty"`
	// contains filtered or unexported fields
}

type UnimplementedBackendPluginServer struct{}

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