appdata

package

v0.1.7 Latest Latest Go to latest Published: Aug 24, 2021 License: BSD-3-Clause Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/r2d2-ai/aiflow

Links

Open Source Insights

README ¶

AppData

This activity allows you to set and get global App attributes.

Installation

AIflow CLI

AIflow install github.com/r2d2-ai/aiflow/common/activity/appdata

Configuration

Settings:

Name	Type	Description
name	string	The name of the shared attribute - REQUIRED
op	string	The operation (get or set), 'get' is the default
type	string	The data type of the shared value, default is 'any'

Input:

Name	Type	Description
value	object	The value of the shared attribute

Output:

Name	Type	Description
value	object	The value of the shared attribute

Examples

Get

Get the value of the 'myAttr' attribute:

{
  "id": "get_app_attr",
  "name": "Get App Attr",
  "activity": {
    "ref": "github.com/r2d2-ai/aiflow/common/activity/appdata",
    "settings": {
      "attribute": "myAttr",
      "operation": "get"
    }
  }
}

Set

Update the value of the 'myAttr' attribute to bar:

{
  "id": "set_app_attr",
  "name": "Set App Attr",
  "activity": {
    "ref": "github.com/r2d2-ai/aiflow/common/activity/appdata",
    "settings": {
      "attribute": "myAttr",
      "operation": "set"
    },
    "input": {
      "value": "bar"
    }  
  }
}

Documentation ¶

Index ¶

func New(ctx activity.InitContext) (activity.Activity, error)
type Activity
- func (a *Activity) Eval(ctx activity.Context) (done bool, err error)
- func (a *Activity) Metadata() *activity.Metadata
type Input
type Output
type Settings

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func New ¶

func New(ctx activity.InitContext) (activity.Activity, error)

Types ¶

type Activity ¶

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

Activity is a Counter Activity implementation

func (*Activity) Eval ¶

func (a *Activity) Eval(ctx activity.Context) (done bool, err error)

Eval implements activity.Activity.Eval

func (*Activity) Metadata ¶

func (a *Activity) Metadata() *activity.Metadata

Metadata implements activity.Activity.Metadata

type Input ¶

type Input struct {
	Value interface{} `md:"value"` // The value of the shared attribute
}

type Output ¶

type Output struct {
	Value interface{} `md:"value"` // The value of the shared attribute
}

type Settings ¶

type Settings struct {
	Name string `md:"name,required"`       // The name of the shared attribute
	Op   string `md:"op,allowed(get,set)"` // The operation (get or set), 'get' is the default
	Type string `md:"type"`                // The data type of the shared value, default is 'any'
}

Source Files ¶

View all Source files

activity.go

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