workflowconnect

package
v0.2.0-b4 Latest Latest
Warning

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

Go to latest
Published: Aug 22, 2025 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// QueueServiceEnqueueActionProcedure is the fully-qualified name of the QueueService's
	// EnqueueAction RPC.
	QueueServiceEnqueueActionProcedure = "/flyteidl.workflow.QueueService/EnqueueAction"
	// QueueServiceAbortQueuedRunProcedure is the fully-qualified name of the QueueService's
	// AbortQueuedRun RPC.
	QueueServiceAbortQueuedRunProcedure = "/flyteidl.workflow.QueueService/AbortQueuedRun"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

View Source
const (
	// RunServiceCreateRunProcedure is the fully-qualified name of the RunService's CreateRun RPC.
	RunServiceCreateRunProcedure = "/flyteidl.workflow.RunService/CreateRun"
	// RunServiceAbortRunProcedure is the fully-qualified name of the RunService's AbortRun RPC.
	RunServiceAbortRunProcedure = "/flyteidl.workflow.RunService/AbortRun"
	// RunServiceGetRunDetailsProcedure is the fully-qualified name of the RunService's GetRunDetails
	// RPC.
	RunServiceGetRunDetailsProcedure = "/flyteidl.workflow.RunService/GetRunDetails"
	// RunServiceWatchRunDetailsProcedure is the fully-qualified name of the RunService's
	// WatchRunDetails RPC.
	RunServiceWatchRunDetailsProcedure = "/flyteidl.workflow.RunService/WatchRunDetails"
	// RunServiceGetActionDetailsProcedure is the fully-qualified name of the RunService's
	// GetActionDetails RPC.
	RunServiceGetActionDetailsProcedure = "/flyteidl.workflow.RunService/GetActionDetails"
	// RunServiceWatchActionDetailsProcedure is the fully-qualified name of the RunService's
	// WatchActionDetails RPC.
	RunServiceWatchActionDetailsProcedure = "/flyteidl.workflow.RunService/WatchActionDetails"
	// RunServiceGetActionDataProcedure is the fully-qualified name of the RunService's GetActionData
	// RPC.
	RunServiceGetActionDataProcedure = "/flyteidl.workflow.RunService/GetActionData"
	// RunServiceListRunsProcedure is the fully-qualified name of the RunService's ListRuns RPC.
	RunServiceListRunsProcedure = "/flyteidl.workflow.RunService/ListRuns"
	// RunServiceWatchRunsProcedure is the fully-qualified name of the RunService's WatchRuns RPC.
	RunServiceWatchRunsProcedure = "/flyteidl.workflow.RunService/WatchRuns"
	// RunServiceListActionsProcedure is the fully-qualified name of the RunService's ListActions RPC.
	RunServiceListActionsProcedure = "/flyteidl.workflow.RunService/ListActions"
	// RunServiceWatchActionsProcedure is the fully-qualified name of the RunService's WatchActions RPC.
	RunServiceWatchActionsProcedure = "/flyteidl.workflow.RunService/WatchActions"
	// RunServiceWatchClusterEventsProcedure is the fully-qualified name of the RunService's
	// WatchClusterEvents RPC.
	RunServiceWatchClusterEventsProcedure = "/flyteidl.workflow.RunService/WatchClusterEvents"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

View Source
const (
	// StateServicePutProcedure is the fully-qualified name of the StateService's Put RPC.
	StateServicePutProcedure = "/flyteidl.workflow.StateService/Put"
	// StateServiceGetProcedure is the fully-qualified name of the StateService's Get RPC.
	StateServiceGetProcedure = "/flyteidl.workflow.StateService/Get"
	// StateServiceWatchProcedure is the fully-qualified name of the StateService's Watch RPC.
	StateServiceWatchProcedure = "/flyteidl.workflow.StateService/Watch"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

View Source
const (
	// TaskServiceDeployTaskProcedure is the fully-qualified name of the TaskService's DeployTask RPC.
	TaskServiceDeployTaskProcedure = "/flyteidl.workflow.TaskService/DeployTask"
	// TaskServiceGetTaskDetailsProcedure is the fully-qualified name of the TaskService's
	// GetTaskDetails RPC.
	TaskServiceGetTaskDetailsProcedure = "/flyteidl.workflow.TaskService/GetTaskDetails"
	// TaskServiceListTasksProcedure is the fully-qualified name of the TaskService's ListTasks RPC.
	TaskServiceListTasksProcedure = "/flyteidl.workflow.TaskService/ListTasks"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

View Source
const (
	// NodeExecutionServiceName is the fully-qualified name of the NodeExecutionService service.
	NodeExecutionServiceName = "flyteidl.workflow.NodeExecutionService"
)
View Source
const (
	// QueueServiceName is the fully-qualified name of the QueueService service.
	QueueServiceName = "flyteidl.workflow.QueueService"
)
View Source
const (
	// RunLogsServiceName is the fully-qualified name of the RunLogsService service.
	RunLogsServiceName = "flyteidl.workflow.RunLogsService"
)
View Source
const (
	// RunLogsServiceTailLogsProcedure is the fully-qualified name of the RunLogsService's TailLogs RPC.
	RunLogsServiceTailLogsProcedure = "/flyteidl.workflow.RunLogsService/TailLogs"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

View Source
const (
	// RunServiceName is the fully-qualified name of the RunService service.
	RunServiceName = "flyteidl.workflow.RunService"
)
View Source
const (
	// StateServiceName is the fully-qualified name of the StateService service.
	StateServiceName = "flyteidl.workflow.StateService"
)
View Source
const (
	// TaskServiceName is the fully-qualified name of the TaskService service.
	TaskServiceName = "flyteidl.workflow.TaskService"
)

Variables

This section is empty.

Functions

func NewNodeExecutionServiceHandler

func NewNodeExecutionServiceHandler(svc NodeExecutionServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewNodeExecutionServiceHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

func NewQueueServiceHandler

func NewQueueServiceHandler(svc QueueServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewQueueServiceHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

func NewRunLogsServiceHandler

func NewRunLogsServiceHandler(svc RunLogsServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewRunLogsServiceHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

func NewRunServiceHandler

func NewRunServiceHandler(svc RunServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewRunServiceHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

func NewStateServiceHandler

func NewStateServiceHandler(svc StateServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewStateServiceHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

func NewTaskServiceHandler

func NewTaskServiceHandler(svc TaskServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)

NewTaskServiceHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

Types

type NodeExecutionServiceClient

type NodeExecutionServiceClient interface {
}

NodeExecutionServiceClient is a client for the flyteidl.workflow.NodeExecutionService service.

func NewNodeExecutionServiceClient

func NewNodeExecutionServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) NodeExecutionServiceClient

NewNodeExecutionServiceClient constructs a client for the flyteidl.workflow.NodeExecutionService service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type NodeExecutionServiceHandler

type NodeExecutionServiceHandler interface {
}

NodeExecutionServiceHandler is an implementation of the flyteidl.workflow.NodeExecutionService service.

type QueueServiceClient

type QueueServiceClient interface {
	// queue a new action for execution.
	EnqueueAction(context.Context, *connect.Request[workflow.EnqueueActionRequest]) (*connect.Response[workflow.EnqueueActionResponse], error)
	// abort a queued run.
	AbortQueuedRun(context.Context, *connect.Request[workflow.AbortQueuedRunRequest]) (*connect.Response[workflow.AbortQueuedRunResponse], error)
}

QueueServiceClient is a client for the flyteidl.workflow.QueueService service.

func NewQueueServiceClient

func NewQueueServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) QueueServiceClient

NewQueueServiceClient constructs a client for the flyteidl.workflow.QueueService service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type QueueServiceHandler

type QueueServiceHandler interface {
	// queue a new action for execution.
	EnqueueAction(context.Context, *connect.Request[workflow.EnqueueActionRequest]) (*connect.Response[workflow.EnqueueActionResponse], error)
	// abort a queued run.
	AbortQueuedRun(context.Context, *connect.Request[workflow.AbortQueuedRunRequest]) (*connect.Response[workflow.AbortQueuedRunResponse], error)
}

QueueServiceHandler is an implementation of the flyteidl.workflow.QueueService service.

type RunLogsServiceClient

RunLogsServiceClient is a client for the flyteidl.workflow.RunLogsService service.

func NewRunLogsServiceClient

func NewRunLogsServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) RunLogsServiceClient

NewRunLogsServiceClient constructs a client for the flyteidl.workflow.RunLogsService service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type RunLogsServiceHandler

type RunLogsServiceHandler interface {
	TailLogs(context.Context, *connect.Request[workflow.TailLogsRequest], *connect.ServerStream[workflow.TailLogsResponse]) error
}

RunLogsServiceHandler is an implementation of the flyteidl.workflow.RunLogsService service.

type RunServiceClient

type RunServiceClient interface {
	// Create a new run of the given task.
	CreateRun(context.Context, *connect.Request[workflow.CreateRunRequest]) (*connect.Response[workflow.CreateRunResponse], error)
	// Abort a run.
	AbortRun(context.Context, *connect.Request[workflow.AbortRunRequest]) (*connect.Response[workflow.AbortRunResponse], error)
	// Get detailed information about a run.
	GetRunDetails(context.Context, *connect.Request[workflow.GetRunDetailsRequest]) (*connect.Response[workflow.GetRunDetailsResponse], error)
	// Stream detailed information updates about a run. The call will terminate when the run reaches a terminal phase.
	WatchRunDetails(context.Context, *connect.Request[workflow.WatchRunDetailsRequest]) (*connect.ServerStreamForClient[workflow.WatchRunDetailsResponse], error)
	// Get detailed information about an action.
	GetActionDetails(context.Context, *connect.Request[workflow.GetActionDetailsRequest]) (*connect.Response[workflow.GetActionDetailsResponse], error)
	// Stream detailed information updates about an action. The call will terminate when the action reaches a terminal phase.
	WatchActionDetails(context.Context, *connect.Request[workflow.WatchActionDetailsRequest]) (*connect.ServerStreamForClient[workflow.WatchActionDetailsResponse], error)
	// Get input and output for an action.
	GetActionData(context.Context, *connect.Request[workflow.GetActionDataRequest]) (*connect.Response[workflow.GetActionDataResponse], error)
	// List runs based on the provided filter criteria.
	ListRuns(context.Context, *connect.Request[workflow.ListRunsRequest]) (*connect.Response[workflow.ListRunsResponse], error)
	// Stream updates for runs based on the provided filter criteria. Responses may include newly discovered
	// runs or updates to existing ones from the point of invocation.
	WatchRuns(context.Context, *connect.Request[workflow.WatchRunsRequest]) (*connect.ServerStreamForClient[workflow.WatchRunsResponse], error)
	// List all actions for a given run.
	ListActions(context.Context, *connect.Request[workflow.ListActionsRequest]) (*connect.Response[workflow.ListActionsResponse], error)
	// Stream updates for actions given a run. Responses may include newly discovered nested runs or updates
	// to  existing ones from the point of invocation.
	WatchActions(context.Context, *connect.Request[workflow.WatchActionsRequest]) (*connect.ServerStreamForClient[workflow.WatchActionsResponse], error)
	// Stream of k8s cluster events in human readable form
	WatchClusterEvents(context.Context, *connect.Request[workflow.WatchClusterEventsRequest]) (*connect.ServerStreamForClient[workflow.WatchClusterEventsResponse], error)
}

RunServiceClient is a client for the flyteidl.workflow.RunService service.

func NewRunServiceClient

func NewRunServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) RunServiceClient

NewRunServiceClient constructs a client for the flyteidl.workflow.RunService service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type RunServiceHandler

type RunServiceHandler interface {
	// Create a new run of the given task.
	CreateRun(context.Context, *connect.Request[workflow.CreateRunRequest]) (*connect.Response[workflow.CreateRunResponse], error)
	// Abort a run.
	AbortRun(context.Context, *connect.Request[workflow.AbortRunRequest]) (*connect.Response[workflow.AbortRunResponse], error)
	// Get detailed information about a run.
	GetRunDetails(context.Context, *connect.Request[workflow.GetRunDetailsRequest]) (*connect.Response[workflow.GetRunDetailsResponse], error)
	// Stream detailed information updates about a run. The call will terminate when the run reaches a terminal phase.
	WatchRunDetails(context.Context, *connect.Request[workflow.WatchRunDetailsRequest], *connect.ServerStream[workflow.WatchRunDetailsResponse]) error
	// Get detailed information about an action.
	GetActionDetails(context.Context, *connect.Request[workflow.GetActionDetailsRequest]) (*connect.Response[workflow.GetActionDetailsResponse], error)
	// Stream detailed information updates about an action. The call will terminate when the action reaches a terminal phase.
	WatchActionDetails(context.Context, *connect.Request[workflow.WatchActionDetailsRequest], *connect.ServerStream[workflow.WatchActionDetailsResponse]) error
	// Get input and output for an action.
	GetActionData(context.Context, *connect.Request[workflow.GetActionDataRequest]) (*connect.Response[workflow.GetActionDataResponse], error)
	// List runs based on the provided filter criteria.
	ListRuns(context.Context, *connect.Request[workflow.ListRunsRequest]) (*connect.Response[workflow.ListRunsResponse], error)
	// Stream updates for runs based on the provided filter criteria. Responses may include newly discovered
	// runs or updates to existing ones from the point of invocation.
	WatchRuns(context.Context, *connect.Request[workflow.WatchRunsRequest], *connect.ServerStream[workflow.WatchRunsResponse]) error
	// List all actions for a given run.
	ListActions(context.Context, *connect.Request[workflow.ListActionsRequest]) (*connect.Response[workflow.ListActionsResponse], error)
	// Stream updates for actions given a run. Responses may include newly discovered nested runs or updates
	// to  existing ones from the point of invocation.
	WatchActions(context.Context, *connect.Request[workflow.WatchActionsRequest], *connect.ServerStream[workflow.WatchActionsResponse]) error
	// Stream of k8s cluster events in human readable form
	WatchClusterEvents(context.Context, *connect.Request[workflow.WatchClusterEventsRequest], *connect.ServerStream[workflow.WatchClusterEventsResponse]) error
}

RunServiceHandler is an implementation of the flyteidl.workflow.RunService service.

type StateServiceClient

type StateServiceClient interface {
	// put the state of an action.
	Put(context.Context) *connect.BidiStreamForClient[workflow.PutRequest, workflow.PutResponse]
	// get the state of an action.
	Get(context.Context) *connect.BidiStreamForClient[workflow.GetRequest, workflow.GetResponse]
	// watch for updates to the state of actions. this api guarantees at-least-once delivery semantics.
	Watch(context.Context, *connect.Request[workflow.WatchRequest]) (*connect.ServerStreamForClient[workflow.WatchResponse], error)
}

StateServiceClient is a client for the flyteidl.workflow.StateService service.

func NewStateServiceClient

func NewStateServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) StateServiceClient

NewStateServiceClient constructs a client for the flyteidl.workflow.StateService service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type StateServiceHandler

type StateServiceHandler interface {
	// put the state of an action.
	Put(context.Context, *connect.BidiStream[workflow.PutRequest, workflow.PutResponse]) error
	// get the state of an action.
	Get(context.Context, *connect.BidiStream[workflow.GetRequest, workflow.GetResponse]) error
	// watch for updates to the state of actions. this api guarantees at-least-once delivery semantics.
	Watch(context.Context, *connect.Request[workflow.WatchRequest], *connect.ServerStream[workflow.WatchResponse]) error
}

StateServiceHandler is an implementation of the flyteidl.workflow.StateService service.

type TaskServiceClient

type TaskServiceClient interface {
	// Deploy a task.
	DeployTask(context.Context, *connect.Request[workflow.DeployTaskRequest]) (*connect.Response[workflow.DeployTaskResponse], error)
	// Get detailed information about a task.
	GetTaskDetails(context.Context, *connect.Request[workflow.GetTaskDetailsRequest]) (*connect.Response[workflow.GetTaskDetailsResponse], error)
	// Lists tasks, one per task name, returning the latest version and who it was deployed by.
	ListTasks(context.Context, *connect.Request[workflow.ListTasksRequest]) (*connect.Response[workflow.ListTasksResponse], error)
}

TaskServiceClient is a client for the flyteidl.workflow.TaskService service.

func NewTaskServiceClient

func NewTaskServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) TaskServiceClient

NewTaskServiceClient constructs a client for the flyteidl.workflow.TaskService service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type TaskServiceHandler

type TaskServiceHandler interface {
	// Deploy a task.
	DeployTask(context.Context, *connect.Request[workflow.DeployTaskRequest]) (*connect.Response[workflow.DeployTaskResponse], error)
	// Get detailed information about a task.
	GetTaskDetails(context.Context, *connect.Request[workflow.GetTaskDetailsRequest]) (*connect.Response[workflow.GetTaskDetailsResponse], error)
	// Lists tasks, one per task name, returning the latest version and who it was deployed by.
	ListTasks(context.Context, *connect.Request[workflow.ListTasksRequest]) (*connect.Response[workflow.ListTasksResponse], error)
}

TaskServiceHandler is an implementation of the flyteidl.workflow.TaskService service.

type UnimplementedNodeExecutionServiceHandler

type UnimplementedNodeExecutionServiceHandler struct{}

UnimplementedNodeExecutionServiceHandler returns CodeUnimplemented from all methods.

type UnimplementedQueueServiceHandler

type UnimplementedQueueServiceHandler struct{}

UnimplementedQueueServiceHandler returns CodeUnimplemented from all methods.

type UnimplementedRunLogsServiceHandler

type UnimplementedRunLogsServiceHandler struct{}

UnimplementedRunLogsServiceHandler returns CodeUnimplemented from all methods.

type UnimplementedRunServiceHandler

type UnimplementedRunServiceHandler struct{}

UnimplementedRunServiceHandler returns CodeUnimplemented from all methods.

type UnimplementedStateServiceHandler

type UnimplementedStateServiceHandler struct{}

UnimplementedStateServiceHandler returns CodeUnimplemented from all methods.

type UnimplementedTaskServiceHandler

type UnimplementedTaskServiceHandler struct{}

UnimplementedTaskServiceHandler returns CodeUnimplemented from all methods.

Jump to

Keyboard shortcuts

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