pluginservicev1

type AcquireResourceLockRequest struct {

	// The ID of the blueprint instance to scope the resource lock to.
	InstanceId string `protobuf:"bytes,1,opt,name=instance_id,json=instanceId" json:"instance_id,omitempty"`
	// The name of the resource in the blueprint to lock.
	ResourceName string `protobuf:"bytes,2,opt,name=resource_name,json=resourceName" json:"resource_name,omitempty"`
	// The identifier of the caller that is seeking to acquire the lock.
	AcquiredBy string                         `protobuf:"bytes,3,opt,name=acquired_by,json=acquiredBy" json:"acquired_by,omitempty"`
	Context    *sharedtypesv1.ProviderContext `protobuf:"bytes,4,opt,name=context" json:"context,omitempty"`
	// contains filtered or unexported fields
}

type AcquireResourceLockResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*AcquireResourceLockResponse_Result
	//	*AcquireResourceLockResponse_ErrorResponse
	Response isAcquireResourceLockResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

type AcquireResourceLockResponse_ErrorResponse struct {
	ErrorResponse *sharedtypesv1.ErrorResponse `protobuf:"bytes,2,opt,name=error_response,json=errorResponse,oneof"`
}

type AcquireResourceLockResponse_Result struct {
	Result *AcquireResourceLockResult `protobuf:"bytes,1,opt,name=result,oneof"`
}

type AcquireResourceLockResult struct {
	Acquired bool `protobuf:"varint,1,opt,name=acquired" json:"acquired,omitempty"`
	// contains filtered or unexported fields
}

type DeployResourceServiceRequest struct {

	// The deploy resource request that is used to deploy
	// the resource with the plugin responsible for the
	// resource provider.
	DeployRequest *sharedtypesv1.DeployResourceRequest `protobuf:"bytes,1,opt,name=deploy_request,json=deployRequest" json:"deploy_request,omitempty"`
	// Whether the plugin should wait for the resource to stabilise
	// before returning a response.
	WaitUntilStable bool `protobuf:"varint,2,opt,name=wait_until_stable,json=waitUntilStable" json:"wait_until_stable,omitempty"`
	// contains filtered or unexported fields
}

type FunctionCheckResult struct {
	HasFunction bool `protobuf:"varint,1,opt,name=has_function,json=hasFunction" json:"has_function,omitempty"`
	// contains filtered or unexported fields
}

type FunctionList struct {
	Functions []string `protobuf:"bytes,1,rep,name=functions" json:"functions,omitempty"`
	// contains filtered or unexported fields
}

type HasFunctionRequest struct {
	FunctionName string `protobuf:"bytes,1,opt,name=function_name,json=functionName" json:"function_name,omitempty"`
	// contains filtered or unexported fields
}

type HasFunctionResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*HasFunctionResponse_FunctionCheckResult
	//	*HasFunctionResponse_ErrorResponse
	Response isHasFunctionResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

type HasFunctionResponse_ErrorResponse struct {
	ErrorResponse *sharedtypesv1.ErrorResponse `protobuf:"bytes,2,opt,name=error_response,json=errorResponse,oneof"`
}

type HasFunctionResponse_FunctionCheckResult struct {
	FunctionCheckResult *FunctionCheckResult `protobuf:"bytes,1,opt,name=function_check_result,json=functionCheckResult,oneof"`
}

type ListFunctionsResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*ListFunctionsResponse_FunctionList
	//	*ListFunctionsResponse_ErrorResponse
	Response isListFunctionsResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

type ListFunctionsResponse_ErrorResponse struct {
	ErrorResponse *sharedtypesv1.ErrorResponse `protobuf:"bytes,2,opt,name=error_response,json=errorResponse,oneof"`
}

type ListFunctionsResponse_FunctionList struct {
	FunctionList *FunctionList `protobuf:"bytes,1,opt,name=function_list,json=functionList,oneof"`
}

type LookupResourceInStateRequest struct {

	// The ID of the blueprint instance to look up the resource in.
	InstanceId string `protobuf:"bytes,1,opt,name=instance_id,json=instanceId" json:"instance_id,omitempty"`
	// The type of the resource to look up.
	// For eaxmple, "aws/iam/role" or "gcloud/compute/instance".
	ResourceType string `protobuf:"bytes,2,opt,name=resource_type,json=resourceType" json:"resource_type,omitempty"`
	// The external identifier of the resource in the provider.
	// This is defined in a resource type spec definition as the
	// `IDField`.
	ExternalId string                         `protobuf:"bytes,3,opt,name=external_id,json=externalId" json:"external_id,omitempty"`
	Context    *sharedtypesv1.ProviderContext `protobuf:"bytes,4,opt,name=context" json:"context,omitempty"`
	// contains filtered or unexported fields
}

type LookupResourceInStateResponse struct {

	// Types that are valid to be assigned to Response:
	//
	//	*LookupResourceInStateResponse_Resource
	//	*LookupResourceInStateResponse_ErrorResponse
	Response isLookupResourceInStateResponse_Response `protobuf_oneof:"response"`
	// contains filtered or unexported fields
}

type LookupResourceInStateResponse_ErrorResponse struct {
	ErrorResponse *sharedtypesv1.ErrorResponse `protobuf:"bytes,2,opt,name=error_response,json=errorResponse,oneof"`
}

type LookupResourceInStateResponse_Resource struct {
	Resource *sharedtypesv1.ResourceState `protobuf:"bytes,1,opt,name=resource,oneof"`
}

type Manager interface {
	// RegisterPlugin registers a plugin with the host system
	// that the manager represents.
	RegisterPlugin(info *PluginInstanceInfo) error
	// DeregisterPlugin deregisters a plugin from the host system
	// that the manager represents.
	DeregisterPlugin(pluginType PluginType, id string) error
	// GetPlugin retrieves a plugin instance based on the plugin type
	// and the plugin ID.
	GetPlugin(pluginType PluginType, id string) *PluginInstance
	// GetPluginMetadata retrieves the metadata of a plugin instance
	// based on the plugin type and the plugin ID.
	// This is useful for retrieving core metadata for plugin
	// documentation.
	GetPluginMetadata(pluginType PluginType, id string) *PluginExtendedMetadata
	// GetPlugins retrieves all plugin instances for a given plugin type.
	GetPlugins(pluginType PluginType) []*PluginInstance
}

type PluginDeregistrationRequest struct {

	// The type of plugin that needs to be deregistered.
	PluginType PluginType `protobuf:"varint,1,opt,name=plugin_type,json=pluginType,enum=pluginservicev1.PluginType" json:"plugin_type,omitempty"`
	// The id of the plugin instance that should correspond to the
	// id that was captured when the plugin was launched.
	InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId" json:"instance_id,omitempty"`
	// The ID of the host that the plugin was registered with.
	// If the host does not match, nothing will be done.
	HostId string `protobuf:"bytes,3,opt,name=host_id,json=hostId" json:"host_id,omitempty"`
	// contains filtered or unexported fields
}

type PluginDeregistrationResponse struct {
	Success bool   `protobuf:"varint,1,opt,name=success" json:"success,omitempty"`
	Message string `protobuf:"bytes,2,opt,name=message" json:"message,omitempty"`
	// contains filtered or unexported fields
}

type PluginExtendedMetadata struct {
	// A semver version for the plugin that can be used
	// for documentation and debugging purposes.
	PluginVersion string
	// A friendly name for the plugin to be displayed
	// in documentation and user interfaces.
	DisplayName string
	// A plain text description of the plugin.
	PlainTextDescription string
	// A formatted description of the plugin
	// that can be formatted with markdown.
	FormattedDescription string
	// The URL of the git repository that the plugin
	// is hosted in.
	RepositoryUrl string
	// The company or individual that authored the plugin.
	Author string
	// The protocol versions that the plugin supports.
	ProtocolVersions []string
}

type PluginFactory func(*PluginInstanceInfo, string) (any, func(), error)

type PluginInstance struct {
	Info *PluginInstanceInfo
	// type assertions should be carried out by callers at runtime
	// to derive the actual client interface based on the plugin type.
	Client    any
	CloseConn func()
}

type PluginInstanceInfo struct {
	PluginType PluginType
	// ProtocolVersions contains the protocol versions that
	// the plugin supports.
	// Currently, the only supported protocol version is "1.0".
	ProtocolVersions []string
	// The unique identifier for the provider plugin.
	// In addition to being unique, the ID should point to the location
	// where the provider plugin can be downloaded.
	// {hostname/}?{namespace}/{provider}
	//
	// For example:
	// registry.bluelink.dev/bluelink/aws
	// bluelink/aws
	//
	// The last portion of the ID is the unique name of the provider
	// that is expected to be used as the namespace for resources, data sources
	// and custom variable types used in blueprints.
	// For example, the namespace for AWS resources is "aws"
	// used in the resource type "aws/lambda/function".
	ID string
	// Metadata that can be used for plugin documentation.
	Metadata *PluginMetadata
	// The ID of an instance of a plugin that has been loaded
	// by the host system.
	InstanceID     string
	TCPPort        int
	UnixSocketPath string
}

type PluginMetadata struct {

	// A semver version for the plugin that can be used
	// for documentation and debugging purposes.
	PluginVersion string `protobuf:"bytes,1,opt,name=plugin_version,json=pluginVersion" json:"plugin_version,omitempty"`
	// A friendly name for the plugin to be displayed
	// in documentation and user interfaces.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName" json:"display_name,omitempty"`
	// A plain text description of the plugin.
	PlainTextDescription string `protobuf:"bytes,3,opt,name=plain_text_description,json=plainTextDescription" json:"plain_text_description,omitempty"`
	// A formatted description of the plugin
	// that can be formatted with markdown.
	FormattedDescription string `protobuf:"bytes,4,opt,name=formatted_description,json=formattedDescription" json:"formatted_description,omitempty"`
	// The URL of the git repository that the plugin
	// is hosted in.
	RepositoryUrl string `protobuf:"bytes,5,opt,name=repository_url,json=repositoryUrl" json:"repository_url,omitempty"`
	// The company or individual that authored the plugin.
	Author string `protobuf:"bytes,6,opt,name=author" json:"author,omitempty"`
	// contains filtered or unexported fields
}

type PluginRegistrationRequest struct {

	// The type of plugin that is registered.
	PluginType PluginType `protobuf:"varint,1,opt,name=plugin_type,json=pluginType,enum=pluginservicev1.PluginType" json:"plugin_type,omitempty"`
	// The unique identifier for the provider plugin.
	// In addition to being unique, the ID should point to the location
	// where the provider plugin can be downloaded.
	// {hostname/}?{namespace}/{provider}
	//
	// For example:
	// registry.bluelink.dev/bluelink/aws
	// bluelink/aws
	PluginId string `protobuf:"bytes,2,opt,name=plugin_id,json=pluginId" json:"plugin_id,omitempty"`
	// The id of the plugin instance that should correspond to the
	// id that was captured when the plugin was launched.
	InstanceId string `protobuf:"bytes,3,opt,name=instance_id,json=instanceId" json:"instance_id,omitempty"`
	// The protocol versions that the plugin supports.
	// Each protocol version must be in the form MAJOR.MINOR,
	// for example: 1.0, 1.1, 2.0.
	ProtocolVersions []string `protobuf:"bytes,4,rep,name=protocol_versions,json=protocolVersions" json:"protocol_versions,omitempty"`
	// Metadata for the plugin that can be used for documentation.
	Metadata *PluginMetadata `protobuf:"bytes,5,opt,name=metadata" json:"metadata,omitempty"`
	// The tcp port that the plugin is listening on.
	// Only the port needs to be specified here as the address
	// can only ever be the loopback address,
	// plugins can not be called from a remote host.
	Port int32 `protobuf:"varint,6,opt,name=port" json:"port,omitempty"`
	// The unix socket that the plugin is listening on.
	UnixSocket string `protobuf:"bytes,7,opt,name=unix_socket,json=unixSocket" json:"unix_socket,omitempty"`
	// contains filtered or unexported fields
}

type PluginRegistrationResponse struct {
	Success bool   `protobuf:"varint,1,opt,name=success" json:"success,omitempty"`
	Message string `protobuf:"bytes,2,opt,name=message" json:"message,omitempty"`
	// The ID of the host that the plugin was registered with.
	// This will be checked against the host that makes requests
	// to the plugin.
	HostId string `protobuf:"bytes,3,opt,name=host_id,json=hostId" json:"host_id,omitempty"`
	// contains filtered or unexported fields
}

type PluginType int32

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

type ServerOption func(*Server)

type ServiceClient interface {
	// Register is used by plugins to register themselves
	// with the deploy engine.
	Register(ctx context.Context, in *PluginRegistrationRequest, opts ...grpc.CallOption) (*PluginRegistrationResponse, error)
	// Deregister is used by plugins to deregister themselves
	// from the deploy engine.
	Deregister(ctx context.Context, in *PluginDeregistrationRequest, opts ...grpc.CallOption) (*PluginDeregistrationResponse, error)
	// CallFunction is used to allow plugins to call functions
	// that have been registered with the deploy engine.
	// Only functions can call other functions, this behaviour is
	// essential to allow for function composition in blueprints.
	CallFunction(ctx context.Context, in *sharedtypesv1.FunctionCallRequest, opts ...grpc.CallOption) (*sharedtypesv1.FunctionCallResponse, error)
	// GetFunctionDefinition is used to get the definition of a function
	// that has been registered with the deploy engine.
	GetFunctionDefinition(ctx context.Context, in *sharedtypesv1.FunctionDefinitionRequest, opts ...grpc.CallOption) (*sharedtypesv1.FunctionDefinitionResponse, error)
	// HasFunction is used to check if a function has been registered
	// with the deploy engine.
	HasFunction(ctx context.Context, in *HasFunctionRequest, opts ...grpc.CallOption) (*HasFunctionResponse, error)
	// ListFunctions is used to list all the functions that have been
	// registered with the deploy engine.
	ListFunctions(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*ListFunctionsResponse, error)
	// DeployResource deals with deploying a resource with the upstream resource provider.
	// THe behaviour of deploy is to create or update the resource configuration and return
	// the resource spec state once the configuration has been created or updated.
	// The caller is responsible for making sure that the input resource spec is valid.
	// The `wait_until_stable` field can be used to determine whether the service should wait for the
	// resource to stabilise before returning a response.
	// This is meant to be used to reuse resource plugins to manage intermediary resources
	// in a link implementation, this must not be used for managing resources that are explicitly
	// defined in a blueprint.
	DeployResource(ctx context.Context, in *DeployResourceServiceRequest, opts ...grpc.CallOption) (*sharedtypesv1.DeployResourceResponse, error)
	// DestroyResource deals with destroying a resource instance if its current
	// state is successfully deployed or cleaning up a corrupt or partially deployed
	// resource instance.
	// The resource instance should be completely removed from the external provider
	// as a result of this operation.
	// This is meant to be used to reuse resource plugins to manage intermediary resources
	// in a link implementation, this must not be used for managing resources that are explicitly
	// defined in a blueprint.
	DestroyResource(ctx context.Context, in *sharedtypesv1.DestroyResourceRequest, opts ...grpc.CallOption) (*sharedtypesv1.DestroyResourceResponse, error)
	// LookupResourceInState retrieves a resource of a given type from the blueprint
	// state.
	// This is meant to be used to allow link implementations to check if intermediary resources
	// are present in the blueprint state, when the intermediary resource should already exist
	// in the blueprint instance so the link can update the resource without impacting drift
	// detection as only links in the same blueprint instance that modify resources are taken into
	// account for drift detection.
	LookupResourceInState(ctx context.Context, in *LookupResourceInStateRequest, opts ...grpc.CallOption) (*LookupResourceInStateResponse, error)
	// AcquireResourceLock acquires a lock on a resource of a given type
	// in the blueprint state to ensure that no other operations
	// are modifying the resource at the same time.
	// This is useful for links that need to update existing resources
	// in the same blueprint as a part of the intermediary resources update phase.
	// The blueprint container will ensure that the lock is released after the
	// update intermediary resources phase is complete for the current link.
	// The lock will be released if the link update fails or a lock timeout occurs.
	AcquireResourceLock(ctx context.Context, in *AcquireResourceLockRequest, opts ...grpc.CallOption) (*AcquireResourceLockResponse, error)
}

type ServiceServer interface {
	// Register is used by plugins to register themselves
	// with the deploy engine.
	Register(context.Context, *PluginRegistrationRequest) (*PluginRegistrationResponse, error)
	// Deregister is used by plugins to deregister themselves
	// from the deploy engine.
	Deregister(context.Context, *PluginDeregistrationRequest) (*PluginDeregistrationResponse, error)
	// CallFunction is used to allow plugins to call functions
	// that have been registered with the deploy engine.
	// Only functions can call other functions, this behaviour is
	// essential to allow for function composition in blueprints.
	CallFunction(context.Context, *sharedtypesv1.FunctionCallRequest) (*sharedtypesv1.FunctionCallResponse, error)
	// GetFunctionDefinition is used to get the definition of a function
	// that has been registered with the deploy engine.
	GetFunctionDefinition(context.Context, *sharedtypesv1.FunctionDefinitionRequest) (*sharedtypesv1.FunctionDefinitionResponse, error)
	// HasFunction is used to check if a function has been registered
	// with the deploy engine.
	HasFunction(context.Context, *HasFunctionRequest) (*HasFunctionResponse, error)
	// ListFunctions is used to list all the functions that have been
	// registered with the deploy engine.
	ListFunctions(context.Context, *emptypb.Empty) (*ListFunctionsResponse, error)
	// DeployResource deals with deploying a resource with the upstream resource provider.
	// THe behaviour of deploy is to create or update the resource configuration and return
	// the resource spec state once the configuration has been created or updated.
	// The caller is responsible for making sure that the input resource spec is valid.
	// The `wait_until_stable` field can be used to determine whether the service should wait for the
	// resource to stabilise before returning a response.
	// This is meant to be used to reuse resource plugins to manage intermediary resources
	// in a link implementation, this must not be used for managing resources that are explicitly
	// defined in a blueprint.
	DeployResource(context.Context, *DeployResourceServiceRequest) (*sharedtypesv1.DeployResourceResponse, error)
	// DestroyResource deals with destroying a resource instance if its current
	// state is successfully deployed or cleaning up a corrupt or partially deployed
	// resource instance.
	// The resource instance should be completely removed from the external provider
	// as a result of this operation.
	// This is meant to be used to reuse resource plugins to manage intermediary resources
	// in a link implementation, this must not be used for managing resources that are explicitly
	// defined in a blueprint.
	DestroyResource(context.Context, *sharedtypesv1.DestroyResourceRequest) (*sharedtypesv1.DestroyResourceResponse, error)
	// LookupResourceInState retrieves a resource of a given type from the blueprint
	// state.
	// This is meant to be used to allow link implementations to check if intermediary resources
	// are present in the blueprint state, when the intermediary resource should already exist
	// in the blueprint instance so the link can update the resource without impacting drift
	// detection as only links in the same blueprint instance that modify resources are taken into
	// account for drift detection.
	LookupResourceInState(context.Context, *LookupResourceInStateRequest) (*LookupResourceInStateResponse, error)
	// AcquireResourceLock acquires a lock on a resource of a given type
	// in the blueprint state to ensure that no other operations
	// are modifying the resource at the same time.
	// This is useful for links that need to update existing resources
	// in the same blueprint as a part of the intermediary resources update phase.
	// The blueprint container will ensure that the lock is released after the
	// update intermediary resources phase is complete for the current link.
	// The lock will be released if the link update fails or a lock timeout occurs.
	AcquireResourceLock(context.Context, *AcquireResourceLockRequest) (*AcquireResourceLockResponse, error)
	// contains filtered or unexported methods
}

type ServiceServerOption func(*pluginServiceServer)

type UnimplementedServiceServer struct{}

type UnsafeServiceServer interface {
	// contains filtered or unexported methods
}