workflowsconnect

package
v1.9.6 Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source
const (
	// WorkflowDefinitionPersistServiceCreateWorkflowDefinitionProcedure is the fully-qualified name of
	// the WorkflowDefinitionPersistService's CreateWorkflowDefinition RPC.
	WorkflowDefinitionPersistServiceCreateWorkflowDefinitionProcedure = "/api.v1alpha1.workflows.WorkflowDefinitionPersistService/CreateWorkflowDefinition"
	// WorkflowDefinitionPersistServiceGetWorkflowDefinitionProcedure is the fully-qualified name of the
	// WorkflowDefinitionPersistService's GetWorkflowDefinition RPC.
	WorkflowDefinitionPersistServiceGetWorkflowDefinitionProcedure = "/api.v1alpha1.workflows.WorkflowDefinitionPersistService/GetWorkflowDefinition"
	// WorkflowDefinitionPersistServiceListWorkflowDefinitionsProcedure is the fully-qualified name of
	// the WorkflowDefinitionPersistService's ListWorkflowDefinitions RPC.
	WorkflowDefinitionPersistServiceListWorkflowDefinitionsProcedure = "/api.v1alpha1.workflows.WorkflowDefinitionPersistService/ListWorkflowDefinitions"
	// WorkflowDefinitionPersistServiceUpdateWorkflowDefinitionProcedure is the fully-qualified name of
	// the WorkflowDefinitionPersistService's UpdateWorkflowDefinition RPC.
	WorkflowDefinitionPersistServiceUpdateWorkflowDefinitionProcedure = "/api.v1alpha1.workflows.WorkflowDefinitionPersistService/UpdateWorkflowDefinition"
	// WorkflowDefinitionPersistServiceDeleteWorkflowDefinitionProcedure is the fully-qualified name of
	// the WorkflowDefinitionPersistService's DeleteWorkflowDefinition RPC.
	WorkflowDefinitionPersistServiceDeleteWorkflowDefinitionProcedure = "/api.v1alpha1.workflows.WorkflowDefinitionPersistService/DeleteWorkflowDefinition"
	// WorkflowDefinitionPersistServiceValidateWorkflowDefinitionProcedure is the fully-qualified name
	// of the WorkflowDefinitionPersistService's ValidateWorkflowDefinition RPC.
	WorkflowDefinitionPersistServiceValidateWorkflowDefinitionProcedure = "/api.v1alpha1.workflows.WorkflowDefinitionPersistService/ValidateWorkflowDefinition"
)

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 (
	// WorkflowDefinitionPersistServiceName is the fully-qualified name of the
	// WorkflowDefinitionPersistService service.
	WorkflowDefinitionPersistServiceName = "api.v1alpha1.workflows.WorkflowDefinitionPersistService"
)

Variables

This section is empty.

Functions

func NewWorkflowDefinitionPersistServiceHandler added in v1.7.38

func NewWorkflowDefinitionPersistServiceHandler(svc WorkflowDefinitionPersistServiceHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewWorkflowDefinitionPersistServiceHandler 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 UnimplementedWorkflowDefinitionPersistServiceHandler added in v1.7.38

type UnimplementedWorkflowDefinitionPersistServiceHandler struct{}

UnimplementedWorkflowDefinitionPersistServiceHandler returns CodeUnimplemented from all methods.

type WorkflowDefinitionPersistServiceClient added in v1.7.38

type WorkflowDefinitionPersistServiceClient interface {
	// CreateWorkflowDefinition creates a new flow definition in the database
	CreateWorkflowDefinition(context.Context, *connect_go.Request[workflows.CreateWorkflowDefinitionRequest]) (*connect_go.Response[workflows.CreateWorkflowDefinitionResponse], error)
	// GetWorkflowDefinition retrieves a flow definition from the database
	GetWorkflowDefinition(context.Context, *connect_go.Request[workflows.GetWorkflowDefinitionRequest]) (*connect_go.Response[workflows.GetWorkflowDefinitionResponse], error)
	// ListWorkflowDefinitions retrieves a list of flow definitions from the database optionally filtered by the owning application
	// if application is not specified, all flow definitions for the org are returned
	ListWorkflowDefinitions(context.Context, *connect_go.Request[workflows.ListWorkflowDefinitionsRequest]) (*connect_go.ServerStreamForClient[workflows.ListWorkflowDefinitionsResponse], error)
	// UpdateWorkflowDefinition updates a flow definition in the database. Only the name, description and definition graph itself are updated
	UpdateWorkflowDefinition(context.Context, *connect_go.Request[workflows.UpdateWorkflowDefinitionRequest]) (*connect_go.Response[workflows.UpdateWorkflowDefinitionResponse], error)
	// DeleteWorkflowDefinition deletes a flow definition from the database
	DeleteWorkflowDefinition(context.Context, *connect_go.Request[workflows.DeleteWorkflowDefinitionRequest]) (*connect_go.Response[workflows.DeleteWorkflowDefinitionResponse], error)
	// ValidateWorkflowDefinition validates a flow definition in the database. Only the name, description and definition graph itself are updated
	ValidateWorkflowDefinition(context.Context, *connect_go.Request[workflows.ValidateWorkflowDefinitionRequest]) (*connect_go.Response[workflows.ValidateWorkflowDefinitionResponse], error)
}

WorkflowDefinitionPersistServiceClient is a client for the api.v1alpha1.workflows.WorkflowDefinitionPersistService service.

func NewWorkflowDefinitionPersistServiceClient added in v1.7.38

func NewWorkflowDefinitionPersistServiceClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) WorkflowDefinitionPersistServiceClient

NewWorkflowDefinitionPersistServiceClient constructs a client for the api.v1alpha1.workflows.WorkflowDefinitionPersistService 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 WorkflowDefinitionPersistServiceHandler added in v1.7.38

type WorkflowDefinitionPersistServiceHandler interface {
	// CreateWorkflowDefinition creates a new flow definition in the database
	CreateWorkflowDefinition(context.Context, *connect_go.Request[workflows.CreateWorkflowDefinitionRequest]) (*connect_go.Response[workflows.CreateWorkflowDefinitionResponse], error)
	// GetWorkflowDefinition retrieves a flow definition from the database
	GetWorkflowDefinition(context.Context, *connect_go.Request[workflows.GetWorkflowDefinitionRequest]) (*connect_go.Response[workflows.GetWorkflowDefinitionResponse], error)
	// ListWorkflowDefinitions retrieves a list of flow definitions from the database optionally filtered by the owning application
	// if application is not specified, all flow definitions for the org are returned
	ListWorkflowDefinitions(context.Context, *connect_go.Request[workflows.ListWorkflowDefinitionsRequest], *connect_go.ServerStream[workflows.ListWorkflowDefinitionsResponse]) error
	// UpdateWorkflowDefinition updates a flow definition in the database. Only the name, description and definition graph itself are updated
	UpdateWorkflowDefinition(context.Context, *connect_go.Request[workflows.UpdateWorkflowDefinitionRequest]) (*connect_go.Response[workflows.UpdateWorkflowDefinitionResponse], error)
	// DeleteWorkflowDefinition deletes a flow definition from the database
	DeleteWorkflowDefinition(context.Context, *connect_go.Request[workflows.DeleteWorkflowDefinitionRequest]) (*connect_go.Response[workflows.DeleteWorkflowDefinitionResponse], error)
	// ValidateWorkflowDefinition validates a flow definition in the database. Only the name, description and definition graph itself are updated
	ValidateWorkflowDefinition(context.Context, *connect_go.Request[workflows.ValidateWorkflowDefinitionRequest]) (*connect_go.Response[workflows.ValidateWorkflowDefinitionResponse], error)
}

WorkflowDefinitionPersistServiceHandler is an implementation of the api.v1alpha1.workflows.WorkflowDefinitionPersistService service.

Jump to

Keyboard shortcuts

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