Package xyz.block.ftl.v1.language
Interface LanguageServiceGrpc.AsyncService
-
- All Implemented Interfaces:
public interface LanguageServiceGrpc.AsyncServiceLanguageService allows a plugin to add support for a programming language.
-
-
Method Summary
Modifier and Type Method Description voidping(PingRequest request, StreamObserver<PingResponse> responseObserver)Ping service for readiness.voidgetCreateModuleFlags(GetCreateModuleFlagsRequest request, StreamObserver<GetCreateModuleFlagsResponse> responseObserver)Get language specific flags that can be used to create a new module.voidcreateModule(CreateModuleRequest request, StreamObserver<CreateModuleResponse> responseObserver)Generates files for a new module with the requested namevoidmoduleConfigDefaults(ModuleConfigDefaultsRequest request, StreamObserver<ModuleConfigDefaultsResponse> responseObserver)Provide default values for ModuleConfig for values that are not configured in the ftl.toml file.voidgetDependencies(DependenciesRequest request, StreamObserver<DependenciesResponse> responseObserver)Extract dependencies for a module FTL will ensure that these dependencies are built before requesting a build for this module.voidbuild(BuildRequest request, StreamObserver<BuildEvent> responseObserver)Build the module and stream back build events. A BuildSuccess or BuildFailure event must be streamed back with the request's context id to indicate the end of the build. The request can include the option to "rebuild_automatically". In this case the plugin should watch for file changes and automatically rebuild as needed as long as this build request is alive. Each automactic rebuild must include the latest build context id provided by the request or subsequent BuildContextUpdated calls.voidbuildContextUpdated(BuildContextUpdatedRequest request, StreamObserver<BuildContextUpdatedResponse> responseObserver)While a Build call with "rebuild_automatically" set is active, BuildContextUpdated is called whenever the build context is updated. Each time this call is made, the Build call must send back a corresponding BuildSuccess or BuildFailure event with the updated build context id with "is_automatic_rebuild" as false.-
-
Method Detail
-
ping
void ping(PingRequest request, StreamObserver<PingResponse> responseObserver)
Ping service for readiness.
-
getCreateModuleFlags
void getCreateModuleFlags(GetCreateModuleFlagsRequest request, StreamObserver<GetCreateModuleFlagsResponse> responseObserver)
Get language specific flags that can be used to create a new module.
-
createModule
void createModule(CreateModuleRequest request, StreamObserver<CreateModuleResponse> responseObserver)
Generates files for a new module with the requested name
-
moduleConfigDefaults
void moduleConfigDefaults(ModuleConfigDefaultsRequest request, StreamObserver<ModuleConfigDefaultsResponse> responseObserver)
Provide default values for ModuleConfig for values that are not configured in the ftl.toml file.
-
getDependencies
void getDependencies(DependenciesRequest request, StreamObserver<DependenciesResponse> responseObserver)
Extract dependencies for a module FTL will ensure that these dependencies are built before requesting a build for this module.
-
build
void build(BuildRequest request, StreamObserver<BuildEvent> responseObserver)
Build the module and stream back build events. A BuildSuccess or BuildFailure event must be streamed back with the request's context id to indicate the end of the build. The request can include the option to "rebuild_automatically". In this case the plugin should watch for file changes and automatically rebuild as needed as long as this build request is alive. Each automactic rebuild must include the latest build context id provided by the request or subsequent BuildContextUpdated calls.
-
buildContextUpdated
void buildContextUpdated(BuildContextUpdatedRequest request, StreamObserver<BuildContextUpdatedResponse> responseObserver)
While a Build call with "rebuild_automatically" set is active, BuildContextUpdated is called whenever the build context is updated. Each time this call is made, the Build call must send back a corresponding BuildSuccess or BuildFailure event with the updated build context id with "is_automatic_rebuild" as false.
-
-
-
-