package
0.0.0-20230412210808-dcdb2a03f714
Repository: https://github.com/hashicorp/waypoint-plugin-sdk.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

Configure configures c with the provided configuration.
Documentation returns the documentation for the given component.
Id returns a unique Id that can be used for new values.
Proto returns the proto.Message for a given value that is either already a proto.Message or implements ProtoMarshaler.
ProtoAny returns an *opaqueany.Any for the given ProtoMarshaler object.
ProtoAny returns []*opaqueany.Any for the given input slice by encoding each result into a proto value.
ProtoAnyUnmarshal attempts to unmarshal a ProtoMarshler implementation to another type.

# Constants

Authenticator.
Builder.
ConfigSourcer.
Invalid.
LogPlatform.
Mapper.
Platform.
Registry.
ReleaseManager.
TaskLauncher.

# Variables

TypeMap is a mapping of Type to the nil pointer to the interface of that type.

# Structs

AuthResult is the return value expected from Authenticator.AuthFunc.
ConfigRequest is sent to ReadFunc for ConfigSourcer to represent a single configuration variable that was requested.
DeclaredResources is a group of resources that a plugin had declared to be under it's direct management.
DeclaredResourcesResp is a component used as a vehicle for plugins to communicate the resources that they declare back to core - an "OutParameter".
DeploymentConfig is the configuration for the behavior of a deployment.
DeploymentInfo is available to some plugins to get information about the deployment.
DestroyedResourcesResp is a component used as a vehicle for plugins to communicate the resources that they destroy back to core - an "OutParameter".
ExecResult is returned by an Exec function to indicate the status of the run command.
ExecSessionInfo contains the information required by the exec plugin to setup a new exec and send the data back to a client.
JobInfo is available to plugins to get information about the context in which a job is executing.
No description provided by the author
LogEvent represents a single log entry.
ExecSessionInfo contains the information required by the exec plugin to setup a new exec and send the data back to a client.
LogViewer returns batches of log lines.
See Args.Source in the protobuf protocol.
TaskLaunchInfo is used by TaskLauncher's StartTaskFunc operation.
TaskResult is the result value that must be returned by the RunTask function.
WindowSize provides information about the size of the terminal window.

# Interfaces

AccessInfo is the type of data returned by AccessInfoFunc and made available to the build plugin.
No description provided by the author
Authenticator is responsible for authenticating different types of plugins.
Builder is responsible for building an artifact from source.
BuilderODR is an optional interface that builder type plugins can implement.
ConfigSourcer can be implemented by plugins that support sourcing dynamic configuration for running applications.
Configurable can be optionally implemented by any component to accept user configuration.
ConfigurableNotify is an optional interface that can be implemented by any component to receive a notification that the configuration was decoded.
No description provided by the author
A DeploymentWithUrl is a Deployment that can be referenced with an URL without using any external URL service (like Hashicorp Horizon).
Destroyer is responsible for destroying resources associated with this implementation.
Documented can be optionally implemented by any component to return documentation about the component.
Exec is responsible for starting the exec plugin to allow a deployment plugin to provide it's own exec functionality.
Generation can be implemented by Platform and PlatformReleaser to explicitly specify a "generation" for a deploy or release.
LinesChunkWriter is used by a logs plugin to output a chunk of lines.
LogPlatform is responsible for starting the logs plugin that allows a plugin to read logs for a deployment in its own way.
OutParameter is an argument type that is used by plugins as a vehicle for returning data to core.
Platform is responsible for deploying artifacts.
PlatformReleaser is an optional interface that a Platform can implement to provide default Release functionality.
ProtoMarshaler is the interface required by objects that must support protobuf marshaling.
Registry is responsible for managing artifacts.
RegistryAccess is an optional interface that a registry plugin can implement.
No description provided by the author
ReleaseManager is responsible for taking a deployment and making it "released" which means that traffic can now route to it.
RunningTask is returned from StartTask.
StatusReport can be implemented by Platform and PlatformReleaser to query the target platform and build a report of the current deployments health.
TaskLauncher launches a batch task, ie a task that runs to completion and does not restart.
Template can be implemented by Artifact, Deployment, and Release.
WorkspaceDestroyer is called when a workspace destroy operation is performed (typically via the "waypoint destroy" CLI).

# Type aliases

Type is an enum of all the types of components supported.