pulumi/pkg/resource/plugin/langruntime.go
Joe Duffy f6e694c72b Rename pulumi-fabric to pulumi
This includes a few changes:

* The repo name -- and hence the Go modules -- changes from pulumi-fabric to pulumi.

* The Node.js SDK package changes from @pulumi/pulumi-fabric to just pulumi.

* The CLI is renamed from lumi to pulumi.
2017-09-21 19:18:21 -07:00

30 lines
1.5 KiB
Go

// Copyright 2016-2017, Pulumi Corporation. All rights reserved.
package plugin
import (
"io"
"github.com/pulumi/pulumi/pkg/tokens"
)
// LanguageRuntime is a convenient interface for interacting with language runtime plugins. These tend to be
// dynamically loaded as plugins, although this interface hides this fact from the calling code.
type LanguageRuntime interface {
// Closer closes any underlying OS resources associated with this plugin (like processes, RPC channels, etc).
io.Closer
// Run executes a program in the language runtime for planning or deployment purposes. If info.DryRun is true,
// the code must not assume that side-effects or final values resulting from resource deployments are actually
// available. If it is false, on the other hand, a real deployment is occurring and it may safely depend on these.
Run(info RunInfo) (string, error)
}
// RunInfo contains all of the information required to perform a plan or deployment operation.
type RunInfo struct {
Pwd string // the program's working directory.
Program string // the path to the program to execute.
Args []string // any arguments to pass to the program.
Config map[tokens.ModuleMember]string // the configuration variables to apply before running.
DryRun bool // true if we are performing a dry-run (plan).
Parallel int // the degree of parallelism for resource operations (<=1 for serial).
}