languagepb

package
v0.407.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 29, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	Error_ErrorLevel_name = map[int32]string{
		0: "INFO",
		1: "WARN",
		2: "ERROR",
	}
	Error_ErrorLevel_value = map[string]int32{
		"INFO":  0,
		"WARN":  1,
		"ERROR": 2,
	}
)

Enum value maps for Error_ErrorLevel.

View Source 
var (
	Error_ErrorType_name = map[int32]string{
		0: "FTL",
		1: "COMPILER",
	}
	Error_ErrorType_value = map[string]int32{
		"FTL":      0,
		"COMPILER": 1,
	}
)

Enum value maps for Error_ErrorType.

View Source 
var File_xyz_block_ftl_v1_language_language_proto protoreflect.FileDescriptor

Functions

func ErrorsFromProto 

func ErrorsFromProto(e *ErrorList) []builderrors.Error

ErrorsFromProto converts a protobuf ErrorList to a []builderrors.Error.

func ModuleConfigFromProto added in v0.386.0 

func ModuleConfigFromProto(proto *ModuleConfig) moduleconfig.AbsModuleConfig

ModuleConfigFromProto converts a protobuf ModuleConfig to a moduleconfig.AbsModuleConfig.

func PosFromProto 

func PosFromProto(pos *Position) optional.Option[builderrors.Position]

func ProjectConfigFromProto added in v0.386.0 

func ProjectConfigFromProto(proto *ProjectConfig) projectconfig.Config

Types

type AutoRebuildStarted 

type AutoRebuildStarted struct {
	ContextId string `protobuf:"bytes,1,opt,name=context_id,json=contextId,proto3" json:"context_id,omitempty"`
	// contains filtered or unexported fields
}

AutoRebuildStarted should be sent when the plugin decides to start rebuilding automatically.

It is not required to send this event, though it helps inform the user that their changes are not yet built. FTL may ignore this event if it does not match FTL's current build context and state. If the plugin decides to cancel the build because another build started, no failure or cancellation event needs to be sent.

func (*AutoRebuildStarted) Descriptor deprecated 

func (*AutoRebuildStarted) Descriptor() ([]byte, []int)

Deprecated: Use AutoRebuildStarted.ProtoReflect.Descriptor instead.

func (*AutoRebuildStarted) GetContextId 

func (x *AutoRebuildStarted) GetContextId() string

func (*AutoRebuildStarted) ProtoMessage 

func (*AutoRebuildStarted) ProtoMessage()

func (*AutoRebuildStarted) ProtoReflect 

func (x *AutoRebuildStarted) ProtoReflect() protoreflect.Message

func (*AutoRebuildStarted) Reset 

func (x *AutoRebuildStarted) Reset()

func (*AutoRebuildStarted) String 

func (x *AutoRebuildStarted) String() string

type BuildContext 

type BuildContext struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The configuration for the module
	ModuleConfig *ModuleConfig `protobuf:"bytes,2,opt,name=module_config,json=moduleConfig,proto3" json:"module_config,omitempty"`
	// The FTL schema including all dependencies
	Schema *schema.Schema `protobuf:"bytes,3,opt,name=schema,proto3" json:"schema,omitempty"`
	// The dependencies for the module
	Dependencies []string `protobuf:"bytes,4,rep,name=dependencies,proto3" json:"dependencies,omitempty"`
	// Build environment provides environment variables to be set for the build command
	BuildEnv []string `protobuf:"bytes,5,rep,name=build_env,json=buildEnv,proto3" json:"build_env,omitempty"`
	// contains filtered or unexported fields
}

BuildContext contains contextual information needed to build.

Plugins must include the build context's id when a build succeeds or fails. For automatic rebuilds, plugins must use the most recent build context they have received.

func (*BuildContext) Descriptor deprecated 

func (*BuildContext) Descriptor() ([]byte, []int)

Deprecated: Use BuildContext.ProtoReflect.Descriptor instead.

func (*BuildContext) GetBuildEnv added in v0.394.0 

func (x *BuildContext) GetBuildEnv() []string

func (*BuildContext) GetDependencies 

func (x *BuildContext) GetDependencies() []string

func (*BuildContext) GetId 

func (x *BuildContext) GetId() string

func (*BuildContext) GetModuleConfig 

func (x *BuildContext) GetModuleConfig() *ModuleConfig

func (*BuildContext) GetSchema 

func (x *BuildContext) GetSchema() *schema.Schema

func (*BuildContext) ProtoMessage 

func (*BuildContext) ProtoMessage()

func (*BuildContext) ProtoReflect 

func (x *BuildContext) ProtoReflect() protoreflect.Message

func (*BuildContext) Reset 

func (x *BuildContext) Reset()

func (*BuildContext) String 

func (x *BuildContext) String() string

type BuildContextUpdatedRequest 

type BuildContextUpdatedRequest struct {
	BuildContext *BuildContext `protobuf:"bytes,1,opt,name=build_context,json=buildContext,proto3" json:"build_context,omitempty"`
	// contains filtered or unexported fields
}

func (*BuildContextUpdatedRequest) Descriptor deprecated 

func (*BuildContextUpdatedRequest) Descriptor() ([]byte, []int)

Deprecated: Use BuildContextUpdatedRequest.ProtoReflect.Descriptor instead.

func (*BuildContextUpdatedRequest) GetBuildContext 

func (x *BuildContextUpdatedRequest) GetBuildContext() *BuildContext

func (*BuildContextUpdatedRequest) ProtoMessage 

func (*BuildContextUpdatedRequest) ProtoMessage()

func (*BuildContextUpdatedRequest) ProtoReflect 

func (x *BuildContextUpdatedRequest) ProtoReflect() protoreflect.Message

func (*BuildContextUpdatedRequest) Reset 

func (x *BuildContextUpdatedRequest) Reset()

func (*BuildContextUpdatedRequest) String 

func (x *BuildContextUpdatedRequest) String() string

type BuildContextUpdatedResponse 

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

func (*BuildContextUpdatedResponse) Descriptor deprecated 

func (*BuildContextUpdatedResponse) Descriptor() ([]byte, []int)

Deprecated: Use BuildContextUpdatedResponse.ProtoReflect.Descriptor instead.

func (*BuildContextUpdatedResponse) ProtoMessage 

func (*BuildContextUpdatedResponse) ProtoMessage()

func (*BuildContextUpdatedResponse) ProtoReflect 

func (x *BuildContextUpdatedResponse) ProtoReflect() protoreflect.Message

func (*BuildContextUpdatedResponse) Reset 

func (x *BuildContextUpdatedResponse) Reset()

func (*BuildContextUpdatedResponse) String 

func (x *BuildContextUpdatedResponse) String() string

type BuildEvent 

type BuildEvent struct {

	// Types that are assignable to Event:
	//
	//	*BuildEvent_AutoRebuildStarted
	//	*BuildEvent_BuildSuccess
	//	*BuildEvent_BuildFailure
	Event isBuildEvent_Event `protobuf_oneof:"event"`
	// contains filtered or unexported fields
}

Every type of message that can be streamed from the language plugin for a build.

func (*BuildEvent) Descriptor deprecated 

func (*BuildEvent) Descriptor() ([]byte, []int)

Deprecated: Use BuildEvent.ProtoReflect.Descriptor instead.

func (*BuildEvent) GetAutoRebuildStarted 

func (x *BuildEvent) GetAutoRebuildStarted() *AutoRebuildStarted

func (*BuildEvent) GetBuildFailure 

func (x *BuildEvent) GetBuildFailure() *BuildFailure

func (*BuildEvent) GetBuildSuccess 

func (x *BuildEvent) GetBuildSuccess() *BuildSuccess

func (*BuildEvent) GetEvent 

func (m *BuildEvent) GetEvent() isBuildEvent_Event

func (*BuildEvent) ProtoMessage 

func (*BuildEvent) ProtoMessage()

func (*BuildEvent) ProtoReflect 

func (x *BuildEvent) ProtoReflect() protoreflect.Message

func (*BuildEvent) Reset 

func (x *BuildEvent) Reset()

func (*BuildEvent) String 

func (x *BuildEvent) String() string

type BuildEvent_AutoRebuildStarted 

type BuildEvent_AutoRebuildStarted struct {
	AutoRebuildStarted *AutoRebuildStarted `protobuf:"bytes,2,opt,name=auto_rebuild_started,json=autoRebuildStarted,proto3,oneof"`
}

type BuildEvent_BuildFailure 

type BuildEvent_BuildFailure struct {
	BuildFailure *BuildFailure `protobuf:"bytes,4,opt,name=build_failure,json=buildFailure,proto3,oneof"`
}

type BuildEvent_BuildSuccess 

type BuildEvent_BuildSuccess struct {
	BuildSuccess *BuildSuccess `protobuf:"bytes,3,opt,name=build_success,json=buildSuccess,proto3,oneof"`
}

type BuildFailure 

type BuildFailure struct {

	// The id of build context used while building.
	ContextId string `protobuf:"bytes,1,opt,name=context_id,json=contextId,proto3" json:"context_id,omitempty"`
	// Indicates whether the build was automatically started by the plugin, rather than due to a Build rpc call.
	IsAutomaticRebuild bool `protobuf:"varint,2,opt,name=is_automatic_rebuild,json=isAutomaticRebuild,proto3" json:"is_automatic_rebuild,omitempty"`
	// Errors contains any errors that occurred during the build
	Errors *ErrorList `protobuf:"bytes,3,opt,name=errors,proto3" json:"errors,omitempty"`
	// Indicates the plugin determined that the dependencies in the BuildContext are out of date.
	// If a Build stream is being kept open for automatic rebuilds, FTL will call GetDependencies, followed by
	// BuildContextUpdated.
	InvalidateDependencies bool `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

BuildFailure should be sent when a build fails.

FTL may ignore this event if it does not match FTL's current build context and state.

func (*BuildFailure) Descriptor deprecated 

func (*BuildFailure) Descriptor() ([]byte, []int)

Deprecated: Use BuildFailure.ProtoReflect.Descriptor instead.

func (*BuildFailure) GetContextId 

func (x *BuildFailure) GetContextId() string

func (*BuildFailure) GetErrors 

func (x *BuildFailure) GetErrors() *ErrorList

func (*BuildFailure) GetInvalidateDependencies 

func (x *BuildFailure) GetInvalidateDependencies() bool

func (*BuildFailure) GetIsAutomaticRebuild 

func (x *BuildFailure) GetIsAutomaticRebuild() bool

func (*BuildFailure) ProtoMessage 

func (*BuildFailure) ProtoMessage()

func (*BuildFailure) ProtoReflect 

func (x *BuildFailure) ProtoReflect() protoreflect.Message

func (*BuildFailure) Reset 

func (x *BuildFailure) Reset()

func (*BuildFailure) String 

func (x *BuildFailure) String() string

type BuildRequest 

type BuildRequest struct {

	// The root path for the FTL project
	ProjectRoot string `protobuf:"bytes,1,opt,name=project_root,json=projectRoot,proto3" json:"project_root,omitempty"`
	// The path to the directory containing all module stubs. Each module stub is in a subdirectory.
	StubsRoot string `protobuf:"bytes,2,opt,name=stubs_root,json=stubsRoot,proto3" json:"stubs_root,omitempty"`
	// Indicates whether to watch for file changes and automatically rebuild
	RebuildAutomatically bool          `protobuf:"varint,3,opt,name=rebuild_automatically,json=rebuildAutomatically,proto3" json:"rebuild_automatically,omitempty"`
	BuildContext         *BuildContext `protobuf:"bytes,4,opt,name=build_context,json=buildContext,proto3" json:"build_context,omitempty"`
	// contains filtered or unexported fields
}

Request to build a module.

func (*BuildRequest) Descriptor deprecated 

func (*BuildRequest) Descriptor() ([]byte, []int)

Deprecated: Use BuildRequest.ProtoReflect.Descriptor instead.

func (*BuildRequest) GetBuildContext 

func (x *BuildRequest) GetBuildContext() *BuildContext

func (*BuildRequest) GetProjectRoot added in v0.386.0 

func (x *BuildRequest) GetProjectRoot() string

func (*BuildRequest) GetRebuildAutomatically 

func (x *BuildRequest) GetRebuildAutomatically() bool

func (*BuildRequest) GetStubsRoot added in v0.386.0 

func (x *BuildRequest) GetStubsRoot() string

func (*BuildRequest) ProtoMessage 

func (*BuildRequest) ProtoMessage()

func (*BuildRequest) ProtoReflect 

func (x *BuildRequest) ProtoReflect() protoreflect.Message

func (*BuildRequest) Reset 

func (x *BuildRequest) Reset()

func (*BuildRequest) String 

func (x *BuildRequest) String() string

type BuildSuccess 

type BuildSuccess struct {

	// The id of build context used while building.
	ContextId string `protobuf:"bytes,1,opt,name=context_id,json=contextId,proto3" json:"context_id,omitempty"`
	// Indicates whether the build was automatically started by the plugin, rather than due to a Build rpc call.
	IsAutomaticRebuild bool `protobuf:"varint,2,opt,name=is_automatic_rebuild,json=isAutomaticRebuild,proto3" json:"is_automatic_rebuild,omitempty"`
	// Module schema for the built module
	Module *schema.Module `protobuf:"bytes,3,opt,name=module,proto3" json:"module,omitempty"`
	// Paths for files/directories to be deployed
	Deploy []string `protobuf:"bytes,4,rep,name=deploy,proto3" json:"deploy,omitempty"`
	// Name of the docker image to use for the runner
	DockerImage string `protobuf:"bytes,5,opt,name=docker_image,json=dockerImage,proto3" json:"docker_image,omitempty"`
	// Errors contains any errors that occurred during the build
	// No errors can have a level of ERROR, instead a BuildFailure should be sent
	// Instead this is useful for INFO and WARN level errors.
	Errors *ErrorList `protobuf:"bytes,6,opt,name=errors,proto3" json:"errors,omitempty"`
	// Dev mode endpoint URI. If this is set then rather than trying to deploy the module, FTL will start a runner that
	// connects to this endpoint.
	DevEndpoint *string `protobuf:"bytes,7,opt,name=dev_endpoint,json=devEndpoint,proto3,oneof" json:"dev_endpoint,omitempty"`
	// Dev mode debug port
	DebugPort *int32 `protobuf:"varint,8,opt,name=debug_port,json=debugPort,proto3,oneof" json:"debug_port,omitempty"`
	// contains filtered or unexported fields
}

BuildSuccess should be sent when a build succeeds.

FTL may ignore this event if it does not match FTL's current build context and state.

func (*BuildSuccess) Descriptor deprecated 

func (*BuildSuccess) Descriptor() ([]byte, []int)

Deprecated: Use BuildSuccess.ProtoReflect.Descriptor instead.

func (*BuildSuccess) GetContextId 

func (x *BuildSuccess) GetContextId() string

func (*BuildSuccess) GetDebugPort added in v0.399.0 

func (x *BuildSuccess) GetDebugPort() int32

func (*BuildSuccess) GetDeploy 

func (x *BuildSuccess) GetDeploy() []string

func (*BuildSuccess) GetDevEndpoint added in v0.398.0 

func (x *BuildSuccess) GetDevEndpoint() string

func (*BuildSuccess) GetDockerImage 

func (x *BuildSuccess) GetDockerImage() string

func (*BuildSuccess) GetErrors 

func (x *BuildSuccess) GetErrors() *ErrorList

func (*BuildSuccess) GetIsAutomaticRebuild 

func (x *BuildSuccess) GetIsAutomaticRebuild() bool

func (*BuildSuccess) GetModule 

func (x *BuildSuccess) GetModule() *schema.Module

func (*BuildSuccess) ProtoMessage 

func (*BuildSuccess) ProtoMessage()

func (*BuildSuccess) ProtoReflect 

func (x *BuildSuccess) ProtoReflect() protoreflect.Message

func (*BuildSuccess) Reset 

func (x *BuildSuccess) Reset()

func (*BuildSuccess) String 

func (x *BuildSuccess) String() string

type CreateModuleRequest 

type CreateModuleRequest struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The root directory for the module, which does not yet exist.
	// The plugin should create the directory.
	Dir string `protobuf:"bytes,2,opt,name=dir,proto3" json:"dir,omitempty"`
	// The project configuration
	ProjectConfig *ProjectConfig `protobuf:"bytes,3,opt,name=project_config,json=projectConfig,proto3" json:"project_config,omitempty"`
	// Flags contains any values set for those configured in the GetCreateModuleFlags call
	Flags *structpb.Struct `protobuf:"bytes,4,opt,name=flags,proto3" json:"flags,omitempty"`
	// contains filtered or unexported fields
}

Request to create a new module.

func (*CreateModuleRequest) Descriptor deprecated 

func (*CreateModuleRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateModuleRequest.ProtoReflect.Descriptor instead.

func (*CreateModuleRequest) GetDir added in v0.386.0 

func (x *CreateModuleRequest) GetDir() string

func (*CreateModuleRequest) GetFlags 

func (x *CreateModuleRequest) GetFlags() *structpb.Struct

func (*CreateModuleRequest) GetName 

func (x *CreateModuleRequest) GetName() string

func (*CreateModuleRequest) GetProjectConfig 

func (x *CreateModuleRequest) GetProjectConfig() *ProjectConfig

func (*CreateModuleRequest) ProtoMessage 

func (*CreateModuleRequest) ProtoMessage()

func (*CreateModuleRequest) ProtoReflect 

func (x *CreateModuleRequest) ProtoReflect() protoreflect.Message

func (*CreateModuleRequest) Reset 

func (x *CreateModuleRequest) Reset()

func (*CreateModuleRequest) String 

func (x *CreateModuleRequest) String() string

type CreateModuleResponse 

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

Response to a create module request.

func (*CreateModuleResponse) Descriptor deprecated 

func (*CreateModuleResponse) Descriptor() ([]byte, []int)

Deprecated: Use CreateModuleResponse.ProtoReflect.Descriptor instead.

func (*CreateModuleResponse) ProtoMessage 

func (*CreateModuleResponse) ProtoMessage()

func (*CreateModuleResponse) ProtoReflect 

func (x *CreateModuleResponse) ProtoReflect() protoreflect.Message

func (*CreateModuleResponse) Reset 

func (x *CreateModuleResponse) Reset()

func (*CreateModuleResponse) String 

func (x *CreateModuleResponse) String() string

type DependenciesRequest 

type DependenciesRequest struct {
	ModuleConfig *ModuleConfig `protobuf:"bytes,1,opt,name=module_config,json=moduleConfig,proto3" json:"module_config,omitempty"`
	// contains filtered or unexported fields
}

func (*DependenciesRequest) Descriptor deprecated 

func (*DependenciesRequest) Descriptor() ([]byte, []int)

Deprecated: Use DependenciesRequest.ProtoReflect.Descriptor instead.

func (*DependenciesRequest) GetModuleConfig 

func (x *DependenciesRequest) GetModuleConfig() *ModuleConfig

func (*DependenciesRequest) ProtoMessage 

func (*DependenciesRequest) ProtoMessage()

func (*DependenciesRequest) ProtoReflect 

func (x *DependenciesRequest) ProtoReflect() protoreflect.Message

func (*DependenciesRequest) Reset 

func (x *DependenciesRequest) Reset()

func (*DependenciesRequest) String 

func (x *DependenciesRequest) String() string

type DependenciesResponse 

type DependenciesResponse struct {
	Modules []string `protobuf:"bytes,1,rep,name=modules,proto3" json:"modules,omitempty"`
	// contains filtered or unexported fields
}

func (*DependenciesResponse) Descriptor deprecated 

func (*DependenciesResponse) Descriptor() ([]byte, []int)

Deprecated: Use DependenciesResponse.ProtoReflect.Descriptor instead.

func (*DependenciesResponse) GetModules 

func (x *DependenciesResponse) GetModules() []string

func (*DependenciesResponse) ProtoMessage 

func (*DependenciesResponse) ProtoMessage()

func (*DependenciesResponse) ProtoReflect 

func (x *DependenciesResponse) ProtoReflect() protoreflect.Message

func (*DependenciesResponse) Reset 

func (x *DependenciesResponse) Reset()

func (*DependenciesResponse) String 

func (x *DependenciesResponse) String() string

type Error 

type Error struct {
	Msg   string           `protobuf:"bytes,1,opt,name=msg,proto3" json:"msg,omitempty"`
	Level Error_ErrorLevel `protobuf:"varint,4,opt,name=level,proto3,enum=xyz.block.ftl.v1.language.Error_ErrorLevel" json:"level,omitempty"`
	Pos   *Position        `protobuf:"bytes,5,opt,name=pos,proto3,oneof" json:"pos,omitempty"`
	Type  Error_ErrorType  `protobuf:"varint,6,opt,name=type,proto3,enum=xyz.block.ftl.v1.language.Error_ErrorType" json:"type,omitempty"`
	// contains filtered or unexported fields
}

Error contains information about an error that occurred during a build. Errors do not always cause a build failure. Use lesser levels to help guide the user.

func (*Error) Descriptor deprecated 

func (*Error) Descriptor() ([]byte, []int)

Deprecated: Use Error.ProtoReflect.Descriptor instead.

func (*Error) GetLevel 

func (x *Error) GetLevel() Error_ErrorLevel

func (*Error) GetMsg 

func (x *Error) GetMsg() string

func (*Error) GetPos 

func (x *Error) GetPos() *Position

func (*Error) GetType added in v0.388.0 

func (x *Error) GetType() Error_ErrorType

func (*Error) ProtoMessage 

func (*Error) ProtoMessage()

func (*Error) ProtoReflect 

func (x *Error) ProtoReflect() protoreflect.Message

func (*Error) Reset 

func (x *Error) Reset()

func (*Error) String 

func (x *Error) String() string

type ErrorList 

type ErrorList struct {
	Errors []*Error `protobuf:"bytes,1,rep,name=errors,proto3" json:"errors,omitempty"`
	// contains filtered or unexported fields
}

func ErrorsToProto 

func ErrorsToProto(errs []builderrors.Error) *ErrorList

func (*ErrorList) Descriptor deprecated 

func (*ErrorList) Descriptor() ([]byte, []int)

Deprecated: Use ErrorList.ProtoReflect.Descriptor instead.

func (*ErrorList) GetErrors 

func (x *ErrorList) GetErrors() []*Error

func (*ErrorList) ProtoMessage 

func (*ErrorList) ProtoMessage()

func (*ErrorList) ProtoReflect 

func (x *ErrorList) ProtoReflect() protoreflect.Message

func (*ErrorList) Reset 

func (x *ErrorList) Reset()

func (*ErrorList) String 

func (x *ErrorList) String() string

type Error_ErrorLevel 

type Error_ErrorLevel int32
const (
	Error_INFO  Error_ErrorLevel = 0
	Error_WARN  Error_ErrorLevel = 1
	Error_ERROR Error_ErrorLevel = 2
)

func (Error_ErrorLevel) Descriptor 

func (Error_ErrorLevel) Descriptor() protoreflect.EnumDescriptor

func (Error_ErrorLevel) Enum 

func (x Error_ErrorLevel) Enum() *Error_ErrorLevel

func (Error_ErrorLevel) EnumDescriptor deprecated 

func (Error_ErrorLevel) EnumDescriptor() ([]byte, []int)

Deprecated: Use Error_ErrorLevel.Descriptor instead.

func (Error_ErrorLevel) Number 

func (x Error_ErrorLevel) Number() protoreflect.EnumNumber

func (Error_ErrorLevel) String 

func (x Error_ErrorLevel) String() string

func (Error_ErrorLevel) Type 

func (Error_ErrorLevel) Type() protoreflect.EnumType

type Error_ErrorType added in v0.388.0 

type Error_ErrorType int32
const (
	Error_FTL Error_ErrorType = 0
	// Compiler errors are errors that are from the compiler. This is useful to avoid duplicate errors
	// being shown to the user when combining errors from multiple sources (eg: an IDE showing compiler
	// errors and FTL errors via LSP).
	Error_COMPILER Error_ErrorType = 1
)

func (Error_ErrorType) Descriptor added in v0.388.0 

func (Error_ErrorType) Descriptor() protoreflect.EnumDescriptor

func (Error_ErrorType) Enum added in v0.388.0 

func (x Error_ErrorType) Enum() *Error_ErrorType

func (Error_ErrorType) EnumDescriptor deprecated added in v0.388.0 

func (Error_ErrorType) EnumDescriptor() ([]byte, []int)

Deprecated: Use Error_ErrorType.Descriptor instead.

func (Error_ErrorType) Number added in v0.388.0 

func (x Error_ErrorType) Number() protoreflect.EnumNumber

func (Error_ErrorType) String added in v0.388.0 

func (x Error_ErrorType) String() string

func (Error_ErrorType) Type added in v0.388.0 

func (Error_ErrorType) Type() protoreflect.EnumType

type GenerateStubsRequest added in v0.386.0 

type GenerateStubsRequest struct {

	// The directory path to generate stubs into
	Dir string `protobuf:"bytes,1,opt,name=dir,proto3" json:"dir,omitempty"`
	// The schema of the module to generate stubs for
	Module *schema.Module `protobuf:"bytes,2,opt,name=module,proto3" json:"module,omitempty"`
	// The module's configuration to generate stubs for
	ModuleConfig *ModuleConfig `protobuf:"bytes,3,opt,name=module_config,json=moduleConfig,proto3" json:"module_config,omitempty"`
	// Native module configuration is the configuration for a module that uses the plugin's language, if
	// the main moduleConfig provided is of a different language. It is provided as a mechanism to derive
	// language specific information. For example, the language version.
	NativeModuleConfig *ModuleConfig `protobuf:"bytes,4,opt,name=native_module_config,json=nativeModuleConfig,proto3,oneof" json:"native_module_config,omitempty"`
	// contains filtered or unexported fields
}

func (*GenerateStubsRequest) Descriptor deprecated added in v0.386.0 

func (*GenerateStubsRequest) Descriptor() ([]byte, []int)

Deprecated: Use GenerateStubsRequest.ProtoReflect.Descriptor instead.

func (*GenerateStubsRequest) GetDir added in v0.386.0 

func (x *GenerateStubsRequest) GetDir() string

func (*GenerateStubsRequest) GetModule added in v0.386.0 

func (x *GenerateStubsRequest) GetModule() *schema.Module

func (*GenerateStubsRequest) GetModuleConfig added in v0.386.0 

func (x *GenerateStubsRequest) GetModuleConfig() *ModuleConfig

func (*GenerateStubsRequest) GetNativeModuleConfig added in v0.386.0 

func (x *GenerateStubsRequest) GetNativeModuleConfig() *ModuleConfig

func (*GenerateStubsRequest) ProtoMessage added in v0.386.0 

func (*GenerateStubsRequest) ProtoMessage()

func (*GenerateStubsRequest) ProtoReflect added in v0.386.0 

func (x *GenerateStubsRequest) ProtoReflect() protoreflect.Message

func (*GenerateStubsRequest) Reset added in v0.386.0 

func (x *GenerateStubsRequest) Reset()

func (*GenerateStubsRequest) String added in v0.386.0 

func (x *GenerateStubsRequest) String() string

type GenerateStubsResponse added in v0.386.0 

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

func (*GenerateStubsResponse) Descriptor deprecated added in v0.386.0 

func (*GenerateStubsResponse) Descriptor() ([]byte, []int)

Deprecated: Use GenerateStubsResponse.ProtoReflect.Descriptor instead.

func (*GenerateStubsResponse) ProtoMessage added in v0.386.0 

func (*GenerateStubsResponse) ProtoMessage()

func (*GenerateStubsResponse) ProtoReflect added in v0.386.0 

func (x *GenerateStubsResponse) ProtoReflect() protoreflect.Message

func (*GenerateStubsResponse) Reset added in v0.386.0 

func (x *GenerateStubsResponse) Reset()

func (*GenerateStubsResponse) String added in v0.386.0 

func (x *GenerateStubsResponse) String() string

type GetCreateModuleFlagsRequest 

type GetCreateModuleFlagsRequest struct {
	Language string `protobuf:"bytes,1,opt,name=language,proto3" json:"language,omitempty"`
	// contains filtered or unexported fields
}

func (*GetCreateModuleFlagsRequest) Descriptor deprecated 

func (*GetCreateModuleFlagsRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetCreateModuleFlagsRequest.ProtoReflect.Descriptor instead.

func (*GetCreateModuleFlagsRequest) GetLanguage 

func (x *GetCreateModuleFlagsRequest) GetLanguage() string

func (*GetCreateModuleFlagsRequest) ProtoMessage 

func (*GetCreateModuleFlagsRequest) ProtoMessage()

func (*GetCreateModuleFlagsRequest) ProtoReflect 

func (x *GetCreateModuleFlagsRequest) ProtoReflect() protoreflect.Message

func (*GetCreateModuleFlagsRequest) Reset 

func (x *GetCreateModuleFlagsRequest) Reset()

func (*GetCreateModuleFlagsRequest) String 

func (x *GetCreateModuleFlagsRequest) String() string

type GetCreateModuleFlagsResponse 

type GetCreateModuleFlagsResponse struct {
	Flags []*GetCreateModuleFlagsResponse_Flag `protobuf:"bytes,1,rep,name=flags,proto3" json:"flags,omitempty"`
	// contains filtered or unexported fields
}

func (*GetCreateModuleFlagsResponse) Descriptor deprecated 

func (*GetCreateModuleFlagsResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetCreateModuleFlagsResponse.ProtoReflect.Descriptor instead.

func (*GetCreateModuleFlagsResponse) GetFlags 

func (x *GetCreateModuleFlagsResponse) GetFlags() []*GetCreateModuleFlagsResponse_Flag

func (*GetCreateModuleFlagsResponse) ProtoMessage 

func (*GetCreateModuleFlagsResponse) ProtoMessage()

func (*GetCreateModuleFlagsResponse) ProtoReflect 

func (x *GetCreateModuleFlagsResponse) ProtoReflect() protoreflect.Message

func (*GetCreateModuleFlagsResponse) Reset 

func (x *GetCreateModuleFlagsResponse) Reset()

func (*GetCreateModuleFlagsResponse) String 

func (x *GetCreateModuleFlagsResponse) String() string

type GetCreateModuleFlagsResponse_Flag 

type GetCreateModuleFlagsResponse_Flag struct {
	Name  string  `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Help  string  `protobuf:"bytes,2,opt,name=help,proto3" json:"help,omitempty"`
	Envar *string `protobuf:"bytes,3,opt,name=envar,proto3,oneof" json:"envar,omitempty"`
	// short must be a single character
	Short       *string `protobuf:"bytes,4,opt,name=short,proto3,oneof" json:"short,omitempty"`
	Placeholder *string `protobuf:"bytes,5,opt,name=placeholder,proto3,oneof" json:"placeholder,omitempty"`
	Default     *string `protobuf:"bytes,6,opt,name=default,proto3,oneof" json:"default,omitempty"`
	// contains filtered or unexported fields
}

func (*GetCreateModuleFlagsResponse_Flag) Descriptor deprecated 

func (*GetCreateModuleFlagsResponse_Flag) Descriptor() ([]byte, []int)

Deprecated: Use GetCreateModuleFlagsResponse_Flag.ProtoReflect.Descriptor instead.

func (*GetCreateModuleFlagsResponse_Flag) GetDefault 

func (x *GetCreateModuleFlagsResponse_Flag) GetDefault() string

func (*GetCreateModuleFlagsResponse_Flag) GetEnvar 

func (x *GetCreateModuleFlagsResponse_Flag) GetEnvar() string

func (*GetCreateModuleFlagsResponse_Flag) GetHelp 

func (x *GetCreateModuleFlagsResponse_Flag) GetHelp() string

func (*GetCreateModuleFlagsResponse_Flag) GetName 

func (x *GetCreateModuleFlagsResponse_Flag) GetName() string

func (*GetCreateModuleFlagsResponse_Flag) GetPlaceholder 

func (x *GetCreateModuleFlagsResponse_Flag) GetPlaceholder() string

func (*GetCreateModuleFlagsResponse_Flag) GetShort 

func (x *GetCreateModuleFlagsResponse_Flag) GetShort() string

func (*GetCreateModuleFlagsResponse_Flag) ProtoMessage 

func (*GetCreateModuleFlagsResponse_Flag) ProtoMessage()

func (*GetCreateModuleFlagsResponse_Flag) ProtoReflect 

func (x *GetCreateModuleFlagsResponse_Flag) ProtoReflect() protoreflect.Message

func (*GetCreateModuleFlagsResponse_Flag) Reset 

func (x *GetCreateModuleFlagsResponse_Flag) Reset()

func (*GetCreateModuleFlagsResponse_Flag) String 

func (x *GetCreateModuleFlagsResponse_Flag) String() string

type ModuleConfig 

type ModuleConfig struct {

	// Name of the module
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Absolute path to the module's directory
	Dir string `protobuf:"bytes,2,opt,name=dir,proto3" json:"dir,omitempty"`
	// The language of the module
	Language string `protobuf:"bytes,3,opt,name=language,proto3" json:"language,omitempty"`
	// Absolute path to the directory containing all of this module's build artifacts for deployments
	DeployDir string `protobuf:"bytes,4,opt,name=deploy_dir,json=deployDir,proto3" json:"deploy_dir,omitempty"`
	// Build is the command to build the module.
	Build *string `protobuf:"bytes,5,opt,name=build,proto3,oneof" json:"build,omitempty"`
	// DevModeBuild is the command to build the module in dev mode.
	DevModeBuild *string `protobuf:"bytes,6,opt,name=dev_mode_build,json=devModeBuild,proto3,oneof" json:"dev_mode_build,omitempty"`
	// Build lock path to prevent concurrent builds
	BuildLock string `protobuf:"bytes,7,opt,name=build_lock,json=buildLock,proto3" json:"build_lock,omitempty"`
	// The directory to generate protobuf schema files into. These can be picked up by language specific build tools
	GeneratedSchemaDir *string `protobuf:"bytes,8,opt,name=generated_schema_dir,json=generatedSchemaDir,proto3,oneof" json:"generated_schema_dir,omitempty"`
	// Patterns to watch for file changes
	Watch []string `protobuf:"bytes,9,rep,name=watch,proto3" json:"watch,omitempty"`
	// LanguageConfig contains any metadata specific to a specific language.
	// These are stored in the ftl.toml file under the same key as the language (eg: "go", "java")
	LanguageConfig *structpb.Struct `protobuf:"bytes,10,opt,name=language_config,json=languageConfig,proto3" json:"language_config,omitempty"`
	// The directory containing the SQL migration files
	SqlMigrationDir string `protobuf:"bytes,11,opt,name=sql_migration_dir,json=sqlMigrationDir,proto3" json:"sql_migration_dir,omitempty"`
	// contains filtered or unexported fields
}

ModuleConfig contains the configuration for a module, found in the module's ftl.toml file.

func ModuleConfigToProto added in v0.386.0 

func ModuleConfigToProto(config moduleconfig.AbsModuleConfig) (*ModuleConfig, error)

ModuleConfigToProto converts a moduleconfig.AbsModuleConfig to a protobuf ModuleConfig.

Absolute configs are used because relative paths may change resolve differently between parties.

func (*ModuleConfig) Descriptor deprecated 

func (*ModuleConfig) Descriptor() ([]byte, []int)

Deprecated: Use ModuleConfig.ProtoReflect.Descriptor instead.

func (*ModuleConfig) GetBuild 

func (x *ModuleConfig) GetBuild() string

func (*ModuleConfig) GetBuildLock added in v0.386.0 

func (x *ModuleConfig) GetBuildLock() string

func (*ModuleConfig) GetDeployDir 

func (x *ModuleConfig) GetDeployDir() string

func (*ModuleConfig) GetDevModeBuild added in v0.398.0 

func (x *ModuleConfig) GetDevModeBuild() string

func (*ModuleConfig) GetDir added in v0.386.0 

func (x *ModuleConfig) GetDir() string

func (*ModuleConfig) GetGeneratedSchemaDir 

func (x *ModuleConfig) GetGeneratedSchemaDir() string

func (*ModuleConfig) GetLanguage added in v0.386.0 

func (x *ModuleConfig) GetLanguage() string

func (*ModuleConfig) GetLanguageConfig 

func (x *ModuleConfig) GetLanguageConfig() *structpb.Struct

func (*ModuleConfig) GetName 

func (x *ModuleConfig) GetName() string

func (*ModuleConfig) GetSqlMigrationDir added in v0.399.0 

func (x *ModuleConfig) GetSqlMigrationDir() string

func (*ModuleConfig) GetWatch 

func (x *ModuleConfig) GetWatch() []string

func (*ModuleConfig) ProtoMessage 

func (*ModuleConfig) ProtoMessage()

func (*ModuleConfig) ProtoReflect 

func (x *ModuleConfig) ProtoReflect() protoreflect.Message

func (*ModuleConfig) Reset 

func (x *ModuleConfig) Reset()

func (*ModuleConfig) String 

func (x *ModuleConfig) String() string

type ModuleConfigDefaultsRequest 

type ModuleConfigDefaultsRequest struct {
	Dir string `protobuf:"bytes,1,opt,name=dir,proto3" json:"dir,omitempty"`
	// contains filtered or unexported fields
}

func (*ModuleConfigDefaultsRequest) Descriptor deprecated 

func (*ModuleConfigDefaultsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ModuleConfigDefaultsRequest.ProtoReflect.Descriptor instead.

func (*ModuleConfigDefaultsRequest) GetDir added in v0.386.0 

func (x *ModuleConfigDefaultsRequest) GetDir() string

func (*ModuleConfigDefaultsRequest) ProtoMessage 

func (*ModuleConfigDefaultsRequest) ProtoMessage()

func (*ModuleConfigDefaultsRequest) ProtoReflect 

func (x *ModuleConfigDefaultsRequest) ProtoReflect() protoreflect.Message

func (*ModuleConfigDefaultsRequest) Reset 

func (x *ModuleConfigDefaultsRequest) Reset()

func (*ModuleConfigDefaultsRequest) String 

func (x *ModuleConfigDefaultsRequest) String() string

type ModuleConfigDefaultsResponse 

type ModuleConfigDefaultsResponse struct {

	// Default relative path to the directory containing all build artifacts for deployments
	DeployDir string `protobuf:"bytes,1,opt,name=deploy_dir,json=deployDir,proto3" json:"deploy_dir,omitempty"`
	// Default build command
	Build *string `protobuf:"bytes,2,opt,name=build,proto3,oneof" json:"build,omitempty"`
	// Dev mode build command, if different from the regular build command
	DevModeBuild *string `protobuf:"bytes,3,opt,name=dev_mode_build,json=devModeBuild,proto3,oneof" json:"dev_mode_build,omitempty"`
	// Build lock path to prevent concurrent builds
	BuildLock *string `protobuf:"bytes,4,opt,name=build_lock,json=buildLock,proto3,oneof" json:"build_lock,omitempty"`
	// Default relative path to the directory containing generated schema files
	GeneratedSchemaDir *string `protobuf:"bytes,5,opt,name=generated_schema_dir,json=generatedSchemaDir,proto3,oneof" json:"generated_schema_dir,omitempty"`
	// Default patterns to watch for file changes, relative to the module directory
	Watch []string `protobuf:"bytes,6,rep,name=watch,proto3" json:"watch,omitempty"`
	// Default language specific configuration.
	// These defaults are filled in by looking at each root key only. If the key is not present, the default is used.
	LanguageConfig *structpb.Struct `protobuf:"bytes,7,opt,name=language_config,json=languageConfig,proto3" json:"language_config,omitempty"`
	// Default directory containing the SQL migration files
	SqlMigrationDir string `protobuf:"bytes,8,opt,name=sql_migration_dir,json=sqlMigrationDir,proto3" json:"sql_migration_dir,omitempty"`
	// contains filtered or unexported fields
}

ModuleConfigDefaultsResponse provides defaults for ModuleConfig.

The result may be cached by FTL, so defaulting logic should not be changing due to normal module changes. For example, it is valid to return defaults based on which build tool is configured within the module directory, as that is not expected to change during normal operation. It is not recommended to read the module's toml file to determine defaults, as when the toml file is updated, the module defaults will not be recalculated.

func (*ModuleConfigDefaultsResponse) Descriptor deprecated 

func (*ModuleConfigDefaultsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ModuleConfigDefaultsResponse.ProtoReflect.Descriptor instead.

func (*ModuleConfigDefaultsResponse) GetBuild 

func (x *ModuleConfigDefaultsResponse) GetBuild() string

func (*ModuleConfigDefaultsResponse) GetBuildLock added in v0.386.0 

func (x *ModuleConfigDefaultsResponse) GetBuildLock() string

func (*ModuleConfigDefaultsResponse) GetDeployDir 

func (x *ModuleConfigDefaultsResponse) GetDeployDir() string

func (*ModuleConfigDefaultsResponse) GetDevModeBuild added in v0.398.0 

func (x *ModuleConfigDefaultsResponse) GetDevModeBuild() string

func (*ModuleConfigDefaultsResponse) GetGeneratedSchemaDir 

func (x *ModuleConfigDefaultsResponse) GetGeneratedSchemaDir() string

func (*ModuleConfigDefaultsResponse) GetLanguageConfig 

func (x *ModuleConfigDefaultsResponse) GetLanguageConfig() *structpb.Struct

func (*ModuleConfigDefaultsResponse) GetSqlMigrationDir added in v0.399.0 

func (x *ModuleConfigDefaultsResponse) GetSqlMigrationDir() string

func (*ModuleConfigDefaultsResponse) GetWatch 

func (x *ModuleConfigDefaultsResponse) GetWatch() []string

func (*ModuleConfigDefaultsResponse) ProtoMessage 

func (*ModuleConfigDefaultsResponse) ProtoMessage()

func (*ModuleConfigDefaultsResponse) ProtoReflect 

func (x *ModuleConfigDefaultsResponse) ProtoReflect() protoreflect.Message

func (*ModuleConfigDefaultsResponse) Reset 

func (x *ModuleConfigDefaultsResponse) Reset()

func (*ModuleConfigDefaultsResponse) String 

func (x *ModuleConfigDefaultsResponse) String() string

type Position 

type Position struct {
	Filename    string `protobuf:"bytes,1,opt,name=filename,proto3" json:"filename,omitempty"`
	Line        int64  `protobuf:"varint,2,opt,name=line,proto3" json:"line,omitempty"`
	StartColumn int64  `protobuf:"varint,3,opt,name=start_column,json=startColumn,proto3" json:"start_column,omitempty"`
	EndColumn   int64  `protobuf:"varint,4,opt,name=end_column,json=endColumn,proto3" json:"end_column,omitempty"`
	// contains filtered or unexported fields
}

func (*Position) Descriptor deprecated 

func (*Position) Descriptor() ([]byte, []int)

Deprecated: Use Position.ProtoReflect.Descriptor instead.

func (*Position) GetEndColumn 

func (x *Position) GetEndColumn() int64

func (*Position) GetFilename 

func (x *Position) GetFilename() string

func (*Position) GetLine 

func (x *Position) GetLine() int64

func (*Position) GetStartColumn 

func (x *Position) GetStartColumn() int64

func (*Position) ProtoMessage 

func (*Position) ProtoMessage()

func (*Position) ProtoReflect 

func (x *Position) ProtoReflect() protoreflect.Message

func (*Position) Reset 

func (x *Position) Reset()

func (*Position) String 

func (x *Position) String() string

type ProjectConfig 

type ProjectConfig struct {
	Dir    string `protobuf:"bytes,1,opt,name=dir,proto3" json:"dir,omitempty"`
	Name   string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	NoGit  bool   `protobuf:"varint,3,opt,name=no_git,json=noGit,proto3" json:"no_git,omitempty"`
	Hermit bool   `protobuf:"varint,4,opt,name=hermit,proto3" json:"hermit,omitempty"`
	// contains filtered or unexported fields
}

ProjectConfig contains the configuration for a project, found in the ftl-project.toml file.

func ProjectConfigToProto added in v0.386.0 

func ProjectConfigToProto(projConfig projectconfig.Config) *ProjectConfig

func (*ProjectConfig) Descriptor deprecated 

func (*ProjectConfig) Descriptor() ([]byte, []int)

Deprecated: Use ProjectConfig.ProtoReflect.Descriptor instead.

func (*ProjectConfig) GetDir added in v0.386.0 

func (x *ProjectConfig) GetDir() string

func (*ProjectConfig) GetHermit 

func (x *ProjectConfig) GetHermit() bool

func (*ProjectConfig) GetName 

func (x *ProjectConfig) GetName() string

func (*ProjectConfig) GetNoGit 

func (x *ProjectConfig) GetNoGit() bool

func (*ProjectConfig) ProtoMessage 

func (*ProjectConfig) ProtoMessage()

func (*ProjectConfig) ProtoReflect 

func (x *ProjectConfig) ProtoReflect() protoreflect.Message

func (*ProjectConfig) Reset 

func (x *ProjectConfig) Reset()

func (*ProjectConfig) String 

func (x *ProjectConfig) String() string

type SyncStubReferencesRequest added in v0.386.0 

type SyncStubReferencesRequest struct {
	ModuleConfig *ModuleConfig `protobuf:"bytes,1,opt,name=module_config,json=moduleConfig,proto3" json:"module_config,omitempty"`
	// The path of the directory containing all module stubs. Each module is in a subdirectory
	StubsRoot string `protobuf:"bytes,2,opt,name=stubs_root,json=stubsRoot,proto3" json:"stubs_root,omitempty"`
	// The names of all modules that have had stubs generated
	Modules []string `protobuf:"bytes,3,rep,name=modules,proto3" json:"modules,omitempty"`
	// contains filtered or unexported fields
}

func (*SyncStubReferencesRequest) Descriptor deprecated added in v0.386.0 

func (*SyncStubReferencesRequest) Descriptor() ([]byte, []int)

Deprecated: Use SyncStubReferencesRequest.ProtoReflect.Descriptor instead.

func (*SyncStubReferencesRequest) GetModuleConfig added in v0.386.0 

func (x *SyncStubReferencesRequest) GetModuleConfig() *ModuleConfig

func (*SyncStubReferencesRequest) GetModules added in v0.386.0 

func (x *SyncStubReferencesRequest) GetModules() []string

func (*SyncStubReferencesRequest) GetStubsRoot added in v0.386.0 

func (x *SyncStubReferencesRequest) GetStubsRoot() string

func (*SyncStubReferencesRequest) ProtoMessage added in v0.386.0 

func (*SyncStubReferencesRequest) ProtoMessage()

func (*SyncStubReferencesRequest) ProtoReflect added in v0.386.0 

func (x *SyncStubReferencesRequest) ProtoReflect() protoreflect.Message

func (*SyncStubReferencesRequest) Reset added in v0.386.0 

func (x *SyncStubReferencesRequest) Reset()

func (*SyncStubReferencesRequest) String added in v0.386.0 

func (x *SyncStubReferencesRequest) String() string

type SyncStubReferencesResponse added in v0.386.0 

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

func (*SyncStubReferencesResponse) Descriptor deprecated added in v0.386.0 

func (*SyncStubReferencesResponse) Descriptor() ([]byte, []int)

Deprecated: Use SyncStubReferencesResponse.ProtoReflect.Descriptor instead.

func (*SyncStubReferencesResponse) ProtoMessage added in v0.386.0 

func (*SyncStubReferencesResponse) ProtoMessage()

func (*SyncStubReferencesResponse) ProtoReflect added in v0.386.0 

func (x *SyncStubReferencesResponse) ProtoReflect() protoreflect.Message

func (*SyncStubReferencesResponse) Reset added in v0.386.0 

func (x *SyncStubReferencesResponse) Reset()

func (*SyncStubReferencesResponse) String added in v0.386.0 

func (x *SyncStubReferencesResponse) String() string

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.