Documentation
¶
Index ¶
- Constants
- func NewTaskServiceHandler(svc TaskServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
- type TaskServiceClient
- type TaskServiceHandler
- type UnimplementedTaskServiceHandler
- func (UnimplementedTaskServiceHandler) DeployTask(context.Context, *connect.Request[task.DeployTaskRequest]) (*connect.Response[task.DeployTaskResponse], error)
- func (UnimplementedTaskServiceHandler) GetTaskDetails(context.Context, *connect.Request[task.GetTaskDetailsRequest]) (*connect.Response[task.GetTaskDetailsResponse], error)
- func (UnimplementedTaskServiceHandler) ListTasks(context.Context, *connect.Request[task.ListTasksRequest]) (*connect.Response[task.ListTasksResponse], error)
- func (UnimplementedTaskServiceHandler) ListVersions(context.Context, *connect.Request[task.ListVersionsRequest]) (*connect.Response[task.ListVersionsResponse], error)
Constants ¶
const ( // TaskServiceDeployTaskProcedure is the fully-qualified name of the TaskService's DeployTask RPC. TaskServiceDeployTaskProcedure = "/flyteidl2.task.TaskService/DeployTask" // TaskServiceGetTaskDetailsProcedure is the fully-qualified name of the TaskService's // GetTaskDetails RPC. TaskServiceGetTaskDetailsProcedure = "/flyteidl2.task.TaskService/GetTaskDetails" // TaskServiceListTasksProcedure is the fully-qualified name of the TaskService's ListTasks RPC. TaskServiceListTasksProcedure = "/flyteidl2.task.TaskService/ListTasks" // TaskServiceListVersionsProcedure is the fully-qualified name of the TaskService's ListVersions // RPC. TaskServiceListVersionsProcedure = "/flyteidl2.task.TaskService/ListVersions" )
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.
const (
// TaskServiceName is the fully-qualified name of the TaskService service.
TaskServiceName = "flyteidl2.task.TaskService"
)
Variables ¶
This section is empty.
Functions ¶
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 TaskServiceClient ¶
type TaskServiceClient interface {
// Deploy a task.
DeployTask(context.Context, *connect.Request[task.DeployTaskRequest]) (*connect.Response[task.DeployTaskResponse], error)
// Get detailed information about a task.
GetTaskDetails(context.Context, *connect.Request[task.GetTaskDetailsRequest]) (*connect.Response[task.GetTaskDetailsResponse], error)
// Lists tasks, one per task name, returning the latest version and who it was deployed by.
ListTasks(context.Context, *connect.Request[task.ListTasksRequest]) (*connect.Response[task.ListTasksResponse], error)
// Lists all versions for a task.
ListVersions(context.Context, *connect.Request[task.ListVersionsRequest]) (*connect.Response[task.ListVersionsResponse], error)
}
TaskServiceClient is a client for the flyteidl2.task.TaskService service.
func NewTaskServiceClient ¶
func NewTaskServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) TaskServiceClient
NewTaskServiceClient constructs a client for the flyteidl2.task.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[task.DeployTaskRequest]) (*connect.Response[task.DeployTaskResponse], error)
// Get detailed information about a task.
GetTaskDetails(context.Context, *connect.Request[task.GetTaskDetailsRequest]) (*connect.Response[task.GetTaskDetailsResponse], error)
// Lists tasks, one per task name, returning the latest version and who it was deployed by.
ListTasks(context.Context, *connect.Request[task.ListTasksRequest]) (*connect.Response[task.ListTasksResponse], error)
// Lists all versions for a task.
ListVersions(context.Context, *connect.Request[task.ListVersionsRequest]) (*connect.Response[task.ListVersionsResponse], error)
}
TaskServiceHandler is an implementation of the flyteidl2.task.TaskService service.
type UnimplementedTaskServiceHandler ¶
type UnimplementedTaskServiceHandler struct{}
UnimplementedTaskServiceHandler returns CodeUnimplemented from all methods.
func (UnimplementedTaskServiceHandler) DeployTask ¶
func (UnimplementedTaskServiceHandler) DeployTask(context.Context, *connect.Request[task.DeployTaskRequest]) (*connect.Response[task.DeployTaskResponse], error)
func (UnimplementedTaskServiceHandler) GetTaskDetails ¶
func (UnimplementedTaskServiceHandler) GetTaskDetails(context.Context, *connect.Request[task.GetTaskDetailsRequest]) (*connect.Response[task.GetTaskDetailsResponse], error)
func (UnimplementedTaskServiceHandler) ListTasks ¶
func (UnimplementedTaskServiceHandler) ListTasks(context.Context, *connect.Request[task.ListTasksRequest]) (*connect.Response[task.ListTasksResponse], error)
func (UnimplementedTaskServiceHandler) ListVersions ¶
func (UnimplementedTaskServiceHandler) ListVersions(context.Context, *connect.Request[task.ListVersionsRequest]) (*connect.Response[task.ListVersionsResponse], error)
Source Files