funnel

package
v0.9.3 Latest Latest
Warning

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

 Go to latest Published: Dec 19, 2024 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Overview

Package funnel is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	Funnel_RunWorkflow_FullMethodName   = "/aserto.funnel.v1.Funnel/RunWorkflow"
	Funnel_StartWorkflow_FullMethodName = "/aserto.funnel.v1.Funnel/StartWorkflow"
	Funnel_StopWorkflow_FullMethodName  = "/aserto.funnel.v1.Funnel/StopWorkflow"
)

Variables

View Source 
var File_aserto_funnel_v1_funnel_proto protoreflect.FileDescriptor
View Source 
var Funnel_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "aserto.funnel.v1.Funnel",
	HandlerType: (*FunnelServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "RunWorkflow",
			Handler:    _Funnel_RunWorkflow_Handler,
		},
		{
			MethodName: "StartWorkflow",
			Handler:    _Funnel_StartWorkflow_Handler,
		},
		{
			MethodName: "StopWorkflow",
			Handler:    _Funnel_StopWorkflow_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "aserto/funnel/v1/funnel.proto",
}

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

Functions

func RegisterFunnelHandler 

func RegisterFunnelHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterFunnelHandler registers the http handlers for service Funnel to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterFunnelHandlerClient 

func RegisterFunnelHandlerClient(ctx context.Context, mux *runtime.ServeMux, client FunnelClient) error

RegisterFunnelHandlerClient registers the http handlers for service Funnel to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "FunnelClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "FunnelClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "FunnelClient" to call the correct interceptors. This client ignores the HTTP middlewares.

func RegisterFunnelHandlerFromEndpoint 

func RegisterFunnelHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterFunnelHandlerFromEndpoint is same as RegisterFunnelHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterFunnelHandlerServer 

func RegisterFunnelHandlerServer(ctx context.Context, mux *runtime.ServeMux, server FunnelServer) error

RegisterFunnelHandlerServer registers the http handlers for service Funnel to "mux". UnaryRPC :call FunnelServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterFunnelHandlerFromEndpoint instead. GRPC interceptors will not work for this type of registration. To use interceptors, you must use the "runtime.WithMiddlewares" option in the "runtime.NewServeMux" call.

func RegisterFunnelServer 

func RegisterFunnelServer(s grpc.ServiceRegistrar, srv FunnelServer)

Types

type FunnelClient 

type FunnelClient interface {
	RunWorkflow(ctx context.Context, in *RunWorkflowRequest, opts ...grpc.CallOption) (*RunWorkflowResponse, error)
	StartWorkflow(ctx context.Context, in *StartWorkflowRequest, opts ...grpc.CallOption) (*StartWorkflowResponse, error)
	StopWorkflow(ctx context.Context, in *StopWorkflowRequest, opts ...grpc.CallOption) (*StopWorkflowResponse, error)
}

FunnelClient is the client API for Funnel 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 NewFunnelClient 

func NewFunnelClient(cc grpc.ClientConnInterface) FunnelClient

type FunnelServer 

type FunnelServer interface {
	RunWorkflow(context.Context, *RunWorkflowRequest) (*RunWorkflowResponse, error)
	StartWorkflow(context.Context, *StartWorkflowRequest) (*StartWorkflowResponse, error)
	StopWorkflow(context.Context, *StopWorkflowRequest) (*StopWorkflowResponse, error)
}

FunnelServer is the server API for Funnel service. All implementations should embed UnimplementedFunnelServer for forward compatibility.

type RunWorkflowRequest added in v0.8.40 

type RunWorkflowRequest struct {
	Name string            `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Args []*structpb.Value `protobuf:"bytes,2,rep,name=args,proto3" json:"args,omitempty"`
	// contains filtered or unexported fields
}

func (*RunWorkflowRequest) Descriptor deprecated added in v0.8.40 

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

Deprecated: Use RunWorkflowRequest.ProtoReflect.Descriptor instead.

func (*RunWorkflowRequest) GetArgs added in v0.8.40 

func (x *RunWorkflowRequest) GetArgs() []*structpb.Value

func (*RunWorkflowRequest) GetName added in v0.8.40 

func (x *RunWorkflowRequest) GetName() string

func (*RunWorkflowRequest) ProtoMessage added in v0.8.40 

func (*RunWorkflowRequest) ProtoMessage()

func (*RunWorkflowRequest) ProtoReflect added in v0.8.40 

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

func (*RunWorkflowRequest) Reset added in v0.8.40 

func (x *RunWorkflowRequest) Reset()

func (*RunWorkflowRequest) String added in v0.8.40 

func (x *RunWorkflowRequest) String() string

type RunWorkflowResponse added in v0.8.40 

type RunWorkflowResponse struct {
	Response *v2.WorkflowResponse `protobuf:"bytes,1,opt,name=response,proto3" json:"response,omitempty"`
	// contains filtered or unexported fields
}

func (*RunWorkflowResponse) Descriptor deprecated added in v0.8.40 

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

Deprecated: Use RunWorkflowResponse.ProtoReflect.Descriptor instead.

func (*RunWorkflowResponse) GetResponse added in v0.8.40 

func (x *RunWorkflowResponse) GetResponse() *v2.WorkflowResponse

func (*RunWorkflowResponse) ProtoMessage added in v0.8.40 

func (*RunWorkflowResponse) ProtoMessage()

func (*RunWorkflowResponse) ProtoReflect added in v0.8.40 

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

func (*RunWorkflowResponse) Reset added in v0.8.40 

func (x *RunWorkflowResponse) Reset()

func (*RunWorkflowResponse) String added in v0.8.40 

func (x *RunWorkflowResponse) String() string

type StartWorkflowRequest 

type StartWorkflowRequest struct {
	Name string            `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Args []*structpb.Value `protobuf:"bytes,2,rep,name=args,proto3" json:"args,omitempty"`
	// contains filtered or unexported fields
}

func (*StartWorkflowRequest) Descriptor deprecated 

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

Deprecated: Use StartWorkflowRequest.ProtoReflect.Descriptor instead.

func (*StartWorkflowRequest) GetArgs 

func (x *StartWorkflowRequest) GetArgs() []*structpb.Value

func (*StartWorkflowRequest) GetName 

func (x *StartWorkflowRequest) GetName() string

func (*StartWorkflowRequest) ProtoMessage 

func (*StartWorkflowRequest) ProtoMessage()

func (*StartWorkflowRequest) ProtoReflect 

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

func (*StartWorkflowRequest) Reset 

func (x *StartWorkflowRequest) Reset()

func (*StartWorkflowRequest) String 

func (x *StartWorkflowRequest) String() string

type StartWorkflowResponse 

type StartWorkflowResponse struct {
	WorkflowId string `protobuf:"bytes,1,opt,name=workflow_id,json=workflowId,proto3" json:"workflow_id,omitempty"`
	RunId      string `protobuf:"bytes,2,opt,name=run_id,json=runId,proto3" json:"run_id,omitempty"`
	// contains filtered or unexported fields
}

func (*StartWorkflowResponse) Descriptor deprecated 

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

Deprecated: Use StartWorkflowResponse.ProtoReflect.Descriptor instead.

func (*StartWorkflowResponse) GetRunId 

func (x *StartWorkflowResponse) GetRunId() string

func (*StartWorkflowResponse) GetWorkflowId 

func (x *StartWorkflowResponse) GetWorkflowId() string

func (*StartWorkflowResponse) ProtoMessage 

func (*StartWorkflowResponse) ProtoMessage()

func (*StartWorkflowResponse) ProtoReflect 

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

func (*StartWorkflowResponse) Reset 

func (x *StartWorkflowResponse) Reset()

func (*StartWorkflowResponse) String 

func (x *StartWorkflowResponse) String() string

type StopWorkflowRequest 

type StopWorkflowRequest struct {
	WorkflowId string `protobuf:"bytes,1,opt,name=workflow_id,json=workflowId,proto3" json:"workflow_id,omitempty"`
	RunId      string `protobuf:"bytes,2,opt,name=run_id,json=runId,proto3" json:"run_id,omitempty"`
	// contains filtered or unexported fields
}

func (*StopWorkflowRequest) Descriptor deprecated 

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

Deprecated: Use StopWorkflowRequest.ProtoReflect.Descriptor instead.

func (*StopWorkflowRequest) GetRunId 

func (x *StopWorkflowRequest) GetRunId() string

func (*StopWorkflowRequest) GetWorkflowId 

func (x *StopWorkflowRequest) GetWorkflowId() string

func (*StopWorkflowRequest) ProtoMessage 

func (*StopWorkflowRequest) ProtoMessage()

func (*StopWorkflowRequest) ProtoReflect 

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

func (*StopWorkflowRequest) Reset 

func (x *StopWorkflowRequest) Reset()

func (*StopWorkflowRequest) String 

func (x *StopWorkflowRequest) String() string

type StopWorkflowResponse 

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

func (*StopWorkflowResponse) Descriptor deprecated 

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

Deprecated: Use StopWorkflowResponse.ProtoReflect.Descriptor instead.

func (*StopWorkflowResponse) ProtoMessage 

func (*StopWorkflowResponse) ProtoMessage()

func (*StopWorkflowResponse) ProtoReflect 

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

func (*StopWorkflowResponse) Reset 

func (x *StopWorkflowResponse) Reset()

func (*StopWorkflowResponse) String 

func (x *StopWorkflowResponse) String() string

type UnimplementedFunnelServer 

type UnimplementedFunnelServer struct{}

UnimplementedFunnelServer should 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 (UnimplementedFunnelServer) RunWorkflow added in v0.8.40 

func (UnimplementedFunnelServer) RunWorkflow(context.Context, *RunWorkflowRequest) (*RunWorkflowResponse, error)

func (UnimplementedFunnelServer) StartWorkflow 

func (UnimplementedFunnelServer) StartWorkflow(context.Context, *StartWorkflowRequest) (*StartWorkflowResponse, error)

func (UnimplementedFunnelServer) StopWorkflow 

func (UnimplementedFunnelServer) StopWorkflow(context.Context, *StopWorkflowRequest) (*StopWorkflowResponse, error)

type UnsafeFunnelServer 

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.