executor

package
v0.84.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 21, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source
const (
	Executor_GetControlPlaneConfig_FullMethodName = "/datadog.privateactionrunner.executor.Executor/GetControlPlaneConfig"
	Executor_RunAction_FullMethodName             = "/datadog.privateactionrunner.executor.Executor/RunAction"
	Executor_Health_FullMethodName                = "/datadog.privateactionrunner.executor.Executor/Health"
)

Variables

View Source
var Executor_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "datadog.privateactionrunner.executor.Executor",
	HandlerType: (*ExecutorServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetControlPlaneConfig",
			Handler:    _Executor_GetControlPlaneConfig_Handler,
		},
		{
			MethodName: "Health",
			Handler:    _Executor_Health_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "RunAction",
			Handler:       _Executor_RunAction_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "datadog/privateactionrunner/executor.proto",
}

Executor_ServiceDesc is the grpc.ServiceDesc for Executor service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var File_datadog_privateactionrunner_executor_proto protoreflect.FileDescriptor

Functions

func RegisterExecutorServer

func RegisterExecutorServer(s grpc.ServiceRegistrar, srv ExecutorServer)

Types

type ActionResult

type ActionResult struct {

	// Types that are valid to be assigned to Outcome:
	//
	//	*ActionResult_Output
	//	*ActionResult_Error
	Outcome isActionResult_Outcome `protobuf_oneof:"outcome"`
	// contains filtered or unexported fields
}

ActionResult is the terminal outcome: a success output or a structured error.

func (*ActionResult) Descriptor deprecated

func (*ActionResult) Descriptor() ([]byte, []int)

Deprecated: Use ActionResult.ProtoReflect.Descriptor instead.

func (*ActionResult) GetError

func (*ActionResult) GetOutcome

func (x *ActionResult) GetOutcome() isActionResult_Outcome

func (*ActionResult) GetOutput

func (x *ActionResult) GetOutput() []byte

func (*ActionResult) ProtoMessage

func (*ActionResult) ProtoMessage()

func (*ActionResult) ProtoReflect

func (x *ActionResult) ProtoReflect() protoreflect.Message

func (*ActionResult) Reset

func (x *ActionResult) Reset()

func (*ActionResult) String

func (x *ActionResult) String() string

type ActionResult_Error

type ActionResult_Error struct {
	Error *errorcode.ActionPlatformError `protobuf:"bytes,2,opt,name=error,proto3,oneof"`
}

type ActionResult_Output

type ActionResult_Output struct {
	Output []byte `protobuf:"bytes,1,opt,name=output,proto3,oneof"`
}

type ActionStatus

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

ActionStatus is an optional in-progress update emitted while an action runs.

func (*ActionStatus) Descriptor deprecated

func (*ActionStatus) Descriptor() ([]byte, []int)

Deprecated: Use ActionStatus.ProtoReflect.Descriptor instead.

func (*ActionStatus) GetMessage

func (x *ActionStatus) GetMessage() string

func (*ActionStatus) ProtoMessage

func (*ActionStatus) ProtoMessage()

func (*ActionStatus) ProtoReflect

func (x *ActionStatus) ProtoReflect() protoreflect.Message

func (*ActionStatus) Reset

func (x *ActionStatus) Reset()

func (*ActionStatus) String

func (x *ActionStatus) String() string

type ControlPlaneIdentity added in v0.84.0

type ControlPlaneIdentity struct {
	Urn        string `protobuf:"bytes,1,opt,name=urn,proto3" json:"urn,omitempty"`
	PrivateKey string `protobuf:"bytes,2,opt,name=private_key,json=privateKey,proto3" json:"private_key,omitempty"`
	OrgId      int64  `protobuf:"varint,3,opt,name=org_id,json=orgId,proto3" json:"org_id,omitempty"`
	RunnerId   string `protobuf:"bytes,4,opt,name=runner_id,json=runnerId,proto3" json:"runner_id,omitempty"`
	// contains filtered or unexported fields
}

func (*ControlPlaneIdentity) Descriptor deprecated added in v0.84.0

func (*ControlPlaneIdentity) Descriptor() ([]byte, []int)

Deprecated: Use ControlPlaneIdentity.ProtoReflect.Descriptor instead.

func (*ControlPlaneIdentity) GetOrgId added in v0.84.0

func (x *ControlPlaneIdentity) GetOrgId() int64

func (*ControlPlaneIdentity) GetPrivateKey added in v0.84.0

func (x *ControlPlaneIdentity) GetPrivateKey() string

func (*ControlPlaneIdentity) GetRunnerId added in v0.84.0

func (x *ControlPlaneIdentity) GetRunnerId() string

func (*ControlPlaneIdentity) GetUrn added in v0.84.0

func (x *ControlPlaneIdentity) GetUrn() string

func (*ControlPlaneIdentity) ProtoMessage added in v0.84.0

func (*ControlPlaneIdentity) ProtoMessage()

func (*ControlPlaneIdentity) ProtoReflect added in v0.84.0

func (x *ControlPlaneIdentity) ProtoReflect() protoreflect.Message

func (*ControlPlaneIdentity) Reset added in v0.84.0

func (x *ControlPlaneIdentity) Reset()

func (*ControlPlaneIdentity) String added in v0.84.0

func (x *ControlPlaneIdentity) String() string

type ControlPlaneRuntime added in v0.84.0

type ControlPlaneRuntime struct {
	OpmsBaseUrl       string            `protobuf:"bytes,1,opt,name=opms_base_url,json=opmsBaseUrl,proto3" json:"opms_base_url,omitempty"`
	TaskConcurrency   int32             `protobuf:"varint,2,opt,name=task_concurrency,json=taskConcurrency,proto3" json:"task_concurrency,omitempty"`
	OpmsExtraHeaders  map[string]string `` /* 185-byte string literal not displayed */
	OpmsProxyUrl      string            `protobuf:"bytes,4,opt,name=opms_proxy_url,json=opmsProxyUrl,proto3" json:"opms_proxy_url,omitempty"`
	SkipSslValidation bool              `protobuf:"varint,5,opt,name=skip_ssl_validation,json=skipSslValidation,proto3" json:"skip_ssl_validation,omitempty"`
	MinTlsVersion     string            `protobuf:"bytes,6,opt,name=min_tls_version,json=minTlsVersion,proto3" json:"min_tls_version,omitempty"`
	// contains filtered or unexported fields
}

func (*ControlPlaneRuntime) Descriptor deprecated added in v0.84.0

func (*ControlPlaneRuntime) Descriptor() ([]byte, []int)

Deprecated: Use ControlPlaneRuntime.ProtoReflect.Descriptor instead.

func (*ControlPlaneRuntime) GetMinTlsVersion added in v0.84.0

func (x *ControlPlaneRuntime) GetMinTlsVersion() string

func (*ControlPlaneRuntime) GetOpmsBaseUrl added in v0.84.0

func (x *ControlPlaneRuntime) GetOpmsBaseUrl() string

func (*ControlPlaneRuntime) GetOpmsExtraHeaders added in v0.84.0

func (x *ControlPlaneRuntime) GetOpmsExtraHeaders() map[string]string

func (*ControlPlaneRuntime) GetOpmsProxyUrl added in v0.84.0

func (x *ControlPlaneRuntime) GetOpmsProxyUrl() string

func (*ControlPlaneRuntime) GetSkipSslValidation added in v0.84.0

func (x *ControlPlaneRuntime) GetSkipSslValidation() bool

func (*ControlPlaneRuntime) GetTaskConcurrency added in v0.84.0

func (x *ControlPlaneRuntime) GetTaskConcurrency() int32

func (*ControlPlaneRuntime) ProtoMessage added in v0.84.0

func (*ControlPlaneRuntime) ProtoMessage()

func (*ControlPlaneRuntime) ProtoReflect added in v0.84.0

func (x *ControlPlaneRuntime) ProtoReflect() protoreflect.Message

func (*ControlPlaneRuntime) Reset added in v0.84.0

func (x *ControlPlaneRuntime) Reset()

func (*ControlPlaneRuntime) String added in v0.84.0

func (x *ControlPlaneRuntime) String() string

type ExecutorClient

type ExecutorClient interface {
	GetControlPlaneConfig(ctx context.Context, in *GetControlPlaneConfigRequest, opts ...grpc.CallOption) (*GetControlPlaneConfigResponse, error)
	// RunAction runs a single action and streams updates ending in a final ActionResult.
	RunAction(ctx context.Context, in *RunActionRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[RunActionResponse], error)
	// Health reports executor readiness and liveness; used to gate dispatch.
	Health(ctx context.Context, in *HealthRequest, opts ...grpc.CallOption) (*HealthResponse, error)
}

ExecutorClient is the client API for Executor service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewExecutorClient

func NewExecutorClient(cc grpc.ClientConnInterface) ExecutorClient

type ExecutorServer

type ExecutorServer interface {
	GetControlPlaneConfig(context.Context, *GetControlPlaneConfigRequest) (*GetControlPlaneConfigResponse, error)
	// RunAction runs a single action and streams updates ending in a final ActionResult.
	RunAction(*RunActionRequest, grpc.ServerStreamingServer[RunActionResponse]) error
	// Health reports executor readiness and liveness; used to gate dispatch.
	Health(context.Context, *HealthRequest) (*HealthResponse, error)
	// contains filtered or unexported methods
}

ExecutorServer is the server API for Executor service. All implementations must embed UnimplementedExecutorServer for forward compatibility.

type Executor_RunActionClient

type Executor_RunActionClient = grpc.ServerStreamingClient[RunActionResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type Executor_RunActionServer

type Executor_RunActionServer = grpc.ServerStreamingServer[RunActionResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type GetControlPlaneConfigRequest added in v0.84.0

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

func (*GetControlPlaneConfigRequest) Descriptor deprecated added in v0.84.0

func (*GetControlPlaneConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetControlPlaneConfigRequest.ProtoReflect.Descriptor instead.

func (*GetControlPlaneConfigRequest) ProtoMessage added in v0.84.0

func (*GetControlPlaneConfigRequest) ProtoMessage()

func (*GetControlPlaneConfigRequest) ProtoReflect added in v0.84.0

func (*GetControlPlaneConfigRequest) Reset added in v0.84.0

func (x *GetControlPlaneConfigRequest) Reset()

func (*GetControlPlaneConfigRequest) String added in v0.84.0

type GetControlPlaneConfigResponse added in v0.84.0

type GetControlPlaneConfigResponse struct {
	SplitMode bool                  `protobuf:"varint,1,opt,name=split_mode,json=splitMode,proto3" json:"split_mode,omitempty"`
	LogLevel  string                `protobuf:"bytes,2,opt,name=log_level,json=logLevel,proto3" json:"log_level,omitempty"`
	Identity  *ControlPlaneIdentity `protobuf:"bytes,3,opt,name=identity,proto3" json:"identity,omitempty"`
	Runtime   *ControlPlaneRuntime  `protobuf:"bytes,4,opt,name=runtime,proto3" json:"runtime,omitempty"`
	// contains filtered or unexported fields
}

func (*GetControlPlaneConfigResponse) Descriptor deprecated added in v0.84.0

func (*GetControlPlaneConfigResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetControlPlaneConfigResponse.ProtoReflect.Descriptor instead.

func (*GetControlPlaneConfigResponse) GetIdentity added in v0.84.0

func (*GetControlPlaneConfigResponse) GetLogLevel added in v0.84.0

func (x *GetControlPlaneConfigResponse) GetLogLevel() string

func (*GetControlPlaneConfigResponse) GetRuntime added in v0.84.0

func (*GetControlPlaneConfigResponse) GetSplitMode added in v0.84.0

func (x *GetControlPlaneConfigResponse) GetSplitMode() bool

func (*GetControlPlaneConfigResponse) ProtoMessage added in v0.84.0

func (*GetControlPlaneConfigResponse) ProtoMessage()

func (*GetControlPlaneConfigResponse) ProtoReflect added in v0.84.0

func (*GetControlPlaneConfigResponse) Reset added in v0.84.0

func (x *GetControlPlaneConfigResponse) Reset()

func (*GetControlPlaneConfigResponse) String added in v0.84.0

type HealthRequest

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

func (*HealthRequest) Descriptor deprecated

func (*HealthRequest) Descriptor() ([]byte, []int)

Deprecated: Use HealthRequest.ProtoReflect.Descriptor instead.

func (*HealthRequest) ProtoMessage

func (*HealthRequest) ProtoMessage()

func (*HealthRequest) ProtoReflect

func (x *HealthRequest) ProtoReflect() protoreflect.Message

func (*HealthRequest) Reset

func (x *HealthRequest) Reset()

func (*HealthRequest) String

func (x *HealthRequest) String() string

type HealthResponse

type HealthResponse struct {
	Ready         bool   `protobuf:"varint,1,opt,name=ready,proto3" json:"ready,omitempty"`
	ActiveActions int32  `protobuf:"varint,2,opt,name=active_actions,json=activeActions,proto3" json:"active_actions,omitempty"`
	Version       string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

HealthResponse reports whether the executor can accept actions.

func (*HealthResponse) Descriptor deprecated

func (*HealthResponse) Descriptor() ([]byte, []int)

Deprecated: Use HealthResponse.ProtoReflect.Descriptor instead.

func (*HealthResponse) GetActiveActions

func (x *HealthResponse) GetActiveActions() int32

func (*HealthResponse) GetReady

func (x *HealthResponse) GetReady() bool

func (*HealthResponse) GetVersion

func (x *HealthResponse) GetVersion() string

func (*HealthResponse) ProtoMessage

func (*HealthResponse) ProtoMessage()

func (*HealthResponse) ProtoReflect

func (x *HealthResponse) ProtoReflect() protoreflect.Message

func (*HealthResponse) Reset

func (x *HealthResponse) Reset()

func (*HealthResponse) String

func (x *HealthResponse) String() string

type RunActionRequest

type RunActionRequest struct {
	Task []byte `protobuf:"bytes,1,opt,name=task,proto3" json:"task,omitempty"`
	// contains filtered or unexported fields
}

RunActionRequest carries the raw task bytes as dequeued from OPMS so the executor can verify the task signature itself.

func (*RunActionRequest) Descriptor deprecated

func (*RunActionRequest) Descriptor() ([]byte, []int)

Deprecated: Use RunActionRequest.ProtoReflect.Descriptor instead.

func (*RunActionRequest) GetTask

func (x *RunActionRequest) GetTask() []byte

func (*RunActionRequest) ProtoMessage

func (*RunActionRequest) ProtoMessage()

func (*RunActionRequest) ProtoReflect

func (x *RunActionRequest) ProtoReflect() protoreflect.Message

func (*RunActionRequest) Reset

func (x *RunActionRequest) Reset()

func (*RunActionRequest) String

func (x *RunActionRequest) String() string

type RunActionResponse

type RunActionResponse struct {

	// Types that are valid to be assigned to Event:
	//
	//	*RunActionResponse_Status
	//	*RunActionResponse_Result
	Event isRunActionResponse_Event `protobuf_oneof:"event"`
	// contains filtered or unexported fields
}

RunActionResponse is one event in the RunAction stream, ending with exactly one ActionResult optionally preceded by ActionStatus updates.

func (*RunActionResponse) Descriptor deprecated

func (*RunActionResponse) Descriptor() ([]byte, []int)

Deprecated: Use RunActionResponse.ProtoReflect.Descriptor instead.

func (*RunActionResponse) GetEvent

func (x *RunActionResponse) GetEvent() isRunActionResponse_Event

func (*RunActionResponse) GetResult

func (x *RunActionResponse) GetResult() *ActionResult

func (*RunActionResponse) GetStatus

func (x *RunActionResponse) GetStatus() *ActionStatus

func (*RunActionResponse) ProtoMessage

func (*RunActionResponse) ProtoMessage()

func (*RunActionResponse) ProtoReflect

func (x *RunActionResponse) ProtoReflect() protoreflect.Message

func (*RunActionResponse) Reset

func (x *RunActionResponse) Reset()

func (*RunActionResponse) String

func (x *RunActionResponse) String() string

type RunActionResponse_Result

type RunActionResponse_Result struct {
	Result *ActionResult `protobuf:"bytes,2,opt,name=result,proto3,oneof"`
}

type RunActionResponse_Status

type RunActionResponse_Status struct {
	Status *ActionStatus `protobuf:"bytes,1,opt,name=status,proto3,oneof"`
}

type UnimplementedExecutorServer

type UnimplementedExecutorServer struct{}

UnimplementedExecutorServer 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 (UnimplementedExecutorServer) GetControlPlaneConfig added in v0.84.0

func (UnimplementedExecutorServer) Health

type UnsafeExecutorServer

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

UnsafeExecutorServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ExecutorServer will result in compilation errors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL