Documentation
¶
Index ¶
- Constants
- func NewDataProxyServiceHandler(svc DataProxyServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
- type DataProxyServiceClient
- type DataProxyServiceHandler
- type UnimplementedDataProxyServiceHandler
- func (UnimplementedDataProxyServiceHandler) CreateDownloadLink(context.Context, *connect.Request[dataproxy.CreateDownloadLinkRequest]) (*connect.Response[dataproxy.CreateDownloadLinkResponse], error)
- func (UnimplementedDataProxyServiceHandler) CreateUploadLocation(context.Context, *connect.Request[dataproxy.CreateUploadLocationRequest]) (*connect.Response[dataproxy.CreateUploadLocationResponse], error)
- func (UnimplementedDataProxyServiceHandler) GetActionData(context.Context, *connect.Request[dataproxy.GetActionDataRequest]) (*connect.Response[dataproxy.GetActionDataResponse], error)
- func (UnimplementedDataProxyServiceHandler) TailLogs(context.Context, *connect.Request[dataproxy.TailLogsRequest], ...) error
- func (UnimplementedDataProxyServiceHandler) UploadInputs(context.Context, *connect.Request[dataproxy.UploadInputsRequest]) (*connect.Response[dataproxy.UploadInputsResponse], error)
Constants ¶
const ( // DataProxyServiceCreateUploadLocationProcedure is the fully-qualified name of the // DataProxyService's CreateUploadLocation RPC. DataProxyServiceCreateUploadLocationProcedure = "/flyteidl2.dataproxy.DataProxyService/CreateUploadLocation" // DataProxyServiceUploadInputsProcedure is the fully-qualified name of the DataProxyService's // UploadInputs RPC. DataProxyServiceUploadInputsProcedure = "/flyteidl2.dataproxy.DataProxyService/UploadInputs" // DataProxyServiceCreateDownloadLinkProcedure is the fully-qualified name of the DataProxyService's // CreateDownloadLink RPC. DataProxyServiceCreateDownloadLinkProcedure = "/flyteidl2.dataproxy.DataProxyService/CreateDownloadLink" // DataProxyServiceGetActionDataProcedure is the fully-qualified name of the DataProxyService's // GetActionData RPC. DataProxyServiceGetActionDataProcedure = "/flyteidl2.dataproxy.DataProxyService/GetActionData" // DataProxyServiceTailLogsProcedure is the fully-qualified name of the DataProxyService's TailLogs // RPC. DataProxyServiceTailLogsProcedure = "/flyteidl2.dataproxy.DataProxyService/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.
const (
// DataProxyServiceName is the fully-qualified name of the DataProxyService service.
DataProxyServiceName = "flyteidl2.dataproxy.DataProxyService"
)
Variables ¶
This section is empty.
Functions ¶
func NewDataProxyServiceHandler ¶
func NewDataProxyServiceHandler(svc DataProxyServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
NewDataProxyServiceHandler 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 DataProxyServiceClient ¶
type DataProxyServiceClient interface {
// CreateUploadLocation generates a signed URL for uploading data to the configured storage backend.
CreateUploadLocation(context.Context, *connect.Request[dataproxy.CreateUploadLocationRequest]) (*connect.Response[dataproxy.CreateUploadLocationResponse], error)
UploadInputs(context.Context, *connect.Request[dataproxy.UploadInputsRequest]) (*connect.Response[dataproxy.UploadInputsResponse], error)
// CreateDownloadLink generates signed URL(s) for downloading a given artifact.
CreateDownloadLink(context.Context, *connect.Request[dataproxy.CreateDownloadLinkRequest]) (*connect.Response[dataproxy.CreateDownloadLinkResponse], error)
// Get input and output data for an action.
GetActionData(context.Context, *connect.Request[dataproxy.GetActionDataRequest]) (*connect.Response[dataproxy.GetActionDataResponse], error)
// Stream logs for an action attempt.
TailLogs(context.Context, *connect.Request[dataproxy.TailLogsRequest]) (*connect.ServerStreamForClient[dataproxy.TailLogsResponse], error)
}
DataProxyServiceClient is a client for the flyteidl2.dataproxy.DataProxyService service.
func NewDataProxyServiceClient ¶
func NewDataProxyServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) DataProxyServiceClient
NewDataProxyServiceClient constructs a client for the flyteidl2.dataproxy.DataProxyService 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 DataProxyServiceHandler ¶
type DataProxyServiceHandler interface {
// CreateUploadLocation generates a signed URL for uploading data to the configured storage backend.
CreateUploadLocation(context.Context, *connect.Request[dataproxy.CreateUploadLocationRequest]) (*connect.Response[dataproxy.CreateUploadLocationResponse], error)
UploadInputs(context.Context, *connect.Request[dataproxy.UploadInputsRequest]) (*connect.Response[dataproxy.UploadInputsResponse], error)
// CreateDownloadLink generates signed URL(s) for downloading a given artifact.
CreateDownloadLink(context.Context, *connect.Request[dataproxy.CreateDownloadLinkRequest]) (*connect.Response[dataproxy.CreateDownloadLinkResponse], error)
// Get input and output data for an action.
GetActionData(context.Context, *connect.Request[dataproxy.GetActionDataRequest]) (*connect.Response[dataproxy.GetActionDataResponse], error)
// Stream logs for an action attempt.
TailLogs(context.Context, *connect.Request[dataproxy.TailLogsRequest], *connect.ServerStream[dataproxy.TailLogsResponse]) error
}
DataProxyServiceHandler is an implementation of the flyteidl2.dataproxy.DataProxyService service.
type UnimplementedDataProxyServiceHandler ¶
type UnimplementedDataProxyServiceHandler struct{}
UnimplementedDataProxyServiceHandler returns CodeUnimplemented from all methods.
func (UnimplementedDataProxyServiceHandler) CreateDownloadLink ¶ added in v2.0.12
func (UnimplementedDataProxyServiceHandler) CreateDownloadLink(context.Context, *connect.Request[dataproxy.CreateDownloadLinkRequest]) (*connect.Response[dataproxy.CreateDownloadLinkResponse], error)
func (UnimplementedDataProxyServiceHandler) CreateUploadLocation ¶
func (UnimplementedDataProxyServiceHandler) CreateUploadLocation(context.Context, *connect.Request[dataproxy.CreateUploadLocationRequest]) (*connect.Response[dataproxy.CreateUploadLocationResponse], error)
func (UnimplementedDataProxyServiceHandler) GetActionData ¶ added in v2.0.12
func (UnimplementedDataProxyServiceHandler) GetActionData(context.Context, *connect.Request[dataproxy.GetActionDataRequest]) (*connect.Response[dataproxy.GetActionDataResponse], error)
func (UnimplementedDataProxyServiceHandler) UploadInputs ¶ added in v2.0.10
func (UnimplementedDataProxyServiceHandler) UploadInputs(context.Context, *connect.Request[dataproxy.UploadInputsRequest]) (*connect.Response[dataproxy.UploadInputsResponse], error)