go-sdk-examples

command module
v0.0.0-...-65b78b4 Latest Latest
Warning

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

Go to latest
Published: Jul 3, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

README

Go QuickStart Example

This repository contains sample applications that demonstrates the various features of Conductor Go SDK.

SDK Features

Go SDK for Conductor allows you to:

  1. Create workflow using Code
  2. Execute workflows
  3. Create workers for task execution and framework (TaskRunner) for executing workers and communicating with the server.
  4. Support for all the APIs such as
    1. Managing tasks (poll, update etc.),
    2. Managing workflows (start, pause, resume, terminate, get status, search etc.)
    3. Create and update workflow and task metadata
    4. User and event management
Running Example

Note Obtain KEY and SECRET from the playground or your Conductor server. Quick tutorial for playground

Export variables

export KEY=
export SECRET=
export CONDUCTOR_SERVER_URL=https://play.orkes.io/api

Run the main program

go run main.go

Workflow

We create a simple 2-step workflow that fetches the user details and sends an email.

VisualCode
 
func CreateWorkflow() *workflow.ConductorWorkflow {
	return workflow.NewConductorWorkflow(workflowExecutor).
		Name("user_notification").
		Version(1).
		InputParameters("userId", "notificationPref").
		Add(workflow.NewSimpleTask("get_user_info", "get_user_info").Input("userId", "${workflow.input.userId}")).
        Add(workflow.NewSwitchTask("emailorsms", "${workflow.input.notificationPref}"))
}

Worker

Workers are a simple interface implementation. See workers.go for more details.

Executing Workflows

There are two ways to execute a workflow:

  1. Synchronously - useful for short duration workflows that completes within a few second.
  2. Asynchronously - workflows that runs for longer period
Synchronous Workflow Execution
ConductorWorkflow#ExecuteWorkflow(...)
Asynchronous Workflow Execution
ConductorWorkflow#StartWorkflow(...)

See main.go for complete code sample of workflow execution.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
api

Jump to

Keyboard shortcuts

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