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

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
i.e.
i.e.
i.e.
i.e.
catch-all for types that do not fit well into other predefined roles.
i.e.
i.e.
i.e.
No description provided by the author
No description provided by the author
No description provided by the author
We're expecting it to exist, but it does not.
Some resources in deployment are OK, others are not OK.
No description provided by the author
No description provided by the author

# Variables

Builder_ServiceDesc is the grpc.ServiceDesc for Builder service.
ConfigSourcer_ServiceDesc is the grpc.ServiceDesc for ConfigSourcer service.
ExecSessionService_ServiceDesc is the grpc.ServiceDesc for ExecSessionService service.
No description provided by the author
No description provided by the author
Enum value maps for FuncSpec_Value_PrimitiveType.
Enum value maps for FuncSpec_Value_PrimitiveType.
LogViewer_ServiceDesc is the grpc.ServiceDesc for LogViewer service.
Mapper_ServiceDesc is the grpc.ServiceDesc for Mapper service.
Platform_ServiceDesc is the grpc.ServiceDesc for Platform service.
Registry_ServiceDesc is the grpc.ServiceDesc for Registry service.
ReleaseManager_ServiceDesc is the grpc.ServiceDesc for ReleaseManager service.
Enum value maps for ResourceCategoryDisplayHint.
Enum value maps for ResourceCategoryDisplayHint.
Enum value maps for StatusReport_Health.
Enum value maps for StatusReport_Health.
TaskLauncher_ServiceDesc is the grpc.ServiceDesc for TaskLauncher service.
TerminalUIService_ServiceDesc is the grpc.ServiceDesc for TerminalUIService service.

# Structs

Access is returned by Registry.Access as the return value for the plugin's return value from the AccessInfoFunc call.
No description provided by the author
Args are the common argument types that are available to many of the dynamic functions.
DataDir represents the directory where data can be stored.
No description provided by the author
No description provided by the author
No description provided by the author
See component.DeploymentConfig.
ExecSessionInfo is used to send the information about an exec plugin session.
See component.JobInfo.
LabelSet is a set of labels for anything that can be labeled, such as a deployment, build, etc.
Logger is used to construct an logger for the plugin.
No description provided by the author
ReleaseTargets is the set of targets for a release operation.
Target is a single target for releasing.
See component.Source.
No description provided by the author
TerminalUI is used to construct the terminal.UI for the plugin.
Auth is the namespace of messages related to auth.
AuthResponse is returned by the Auth functions.
No description provided by the author
No description provided by the author
Config is the namespace of messages related to configuration.
ConfigureRequest is the request sent once the configuration decoding is complete to actually assign the values to the structure.
No description provided by the author
No description provided by the author
No description provided by the author
StructResp returns the struct for configuration.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A platform resource that an operation (release/deployment) has created, depends on, or manages.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Returned by Exec plugin functions to indicate the status of the executed command.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ResourceManagerState is the state stored by the framework/resource.Manager structure.
ResourceState is the state of a single resource managed by the framework.
FuncSpec describes a function and is used by the dependency-injection framework to provide the function with the proper values.
Args is the standard argument type for an RPC that is calling a FuncSpec.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Resp is the response for the Generation function.
ImplementsResp returns true if the component implements an additional interface.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Ref contains shared messages used for references to other resources.
DeclaredResource references a declared resource.
No description provided by the author
No description provided by the author
StatusReport is the report genrated when querying the overall health of a deployed or released application.
A resource as observed in a platform.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
UnimplementedBuilderServer must be embedded to have forward compatible implementations.
UnimplementedConfigSourcerServer must be embedded to have forward compatible implementations.
UnimplementedExecSessionServiceServer must be embedded to have forward compatible implementations.
UnimplementedLogViewerServer must be embedded to have forward compatible implementations.
UnimplementedMapperServer must be embedded to have forward compatible implementations.
UnimplementedPlatformServer must be embedded to have forward compatible implementations.
UnimplementedRegistryServer must be embedded to have forward compatible implementations.
UnimplementedReleaseManagerServer must be embedded to have forward compatible implementations.
UnimplementedTaskLauncherServer must be embedded to have forward compatible implementations.
UnimplementedTerminalUIServiceServer must be embedded to have forward compatible implementations.
No description provided by the author

# Interfaces

BuilderClient is the client API for Builder service.
BuilderServer is the server API for Builder service.
ConfigSourcerClient is the client API for ConfigSourcer service.
ConfigSourcerServer is the server API for ConfigSourcer service.
No description provided by the author
No description provided by the author
ExecSessionServiceClient is the client API for ExecSessionService service.
ExecSessionServiceServer is the server API for ExecSessionService service.
No description provided by the author
No description provided by the author
LogViewerClient is the client API for LogViewer service.
LogViewerServer is the server API for LogViewer service.
MapperClient is the client API for Mapper service.
MapperServer is the server API for Mapper service.
PlatformClient is the client API for Platform service.
PlatformServer is the server API for Platform service.
RegistryClient is the client API for Registry service.
RegistryServer is the server API for Registry service.
ReleaseManagerClient is the client API for ReleaseManager service.
ReleaseManagerServer is the server API for ReleaseManager service.
TaskLauncherClient is the client API for TaskLauncher service.
TaskLauncherServer is the server API for TaskLauncher service.
No description provided by the author
No description provided by the author
TerminalUIServiceClient is the client API for TerminalUIService service.
TerminalUIServiceServer is the server API for TerminalUIService service.
UnsafeBuilderServer may be embedded to opt out of forward compatibility for this service.
UnsafeConfigSourcerServer may be embedded to opt out of forward compatibility for this service.
UnsafeExecSessionServiceServer may be embedded to opt out of forward compatibility for this service.
UnsafeLogViewerServer may be embedded to opt out of forward compatibility for this service.
UnsafeMapperServer may be embedded to opt out of forward compatibility for this service.
UnsafePlatformServer may be embedded to opt out of forward compatibility for this service.
UnsafeRegistryServer may be embedded to opt out of forward compatibility for this service.
UnsafeReleaseManagerServer may be embedded to opt out of forward compatibility for this service.
UnsafeTaskLauncherServer may be embedded to opt out of forward compatibility for this service.
UnsafeTerminalUIServiceServer may be embedded to opt out of forward compatibility for this service.

# Type aliases

PrimitiveType are the types of primitives we support.
No description provided by the author
the state of overall health of a deployed application.