Package xyz.block.ftl.v1.language

Class LanguageServiceGrpc.LanguageServiceFutureStub

  • All Implemented Interfaces:
    
public final class LanguageServiceGrpc.LanguageServiceFutureStub
extends AbstractFutureStub<S>

    A stub to allow clients to do ListenableFuture-style rpc calls to service LanguageService. 

    LanguageService allows a plugin to add support for a programming language.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description
      public final Channel channel
      public final CallOptions callOptions

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      ListenableFuture<PingResponse> ping(PingRequest request) 
      Ping service for readiness.
      ListenableFuture<GetCreateModuleFlagsResponse> getCreateModuleFlags(GetCreateModuleFlagsRequest request) 
      Get language specific flags that can be used to create a new module.
      ListenableFuture<CreateModuleResponse> createModule(CreateModuleRequest request) 
      Generates files for a new module with the requested name
      ListenableFuture<ModuleConfigDefaultsResponse> moduleConfigDefaults(ModuleConfigDefaultsRequest request) 
      Provide default values for ModuleConfig for values that are not configured in the ftl.toml file.
      ListenableFuture<DependenciesResponse> getDependencies(DependenciesRequest request) 
      Extract dependencies for a module
FTL will ensure that these dependencies are built before requesting a build for this module.
      ListenableFuture<BuildContextUpdatedResponse> buildContextUpdated(BuildContextUpdatedRequest request) 
      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.
If the plugin will not be able to return a BuildSuccess or BuildFailure, such as when there is no active
build stream, it must fail the BuildContextUpdated call.
      ListenableFuture<GenerateStubsResponse> generateStubs(GenerateStubsRequest request) 
      Generate stubs for a module.
Stubs allow modules to import other module's exported interface. If a language does not need this step,
then it is not required to do anything in this call.
This call is not tied to the module that this plugin is responsible for. A plugin of each language will
be chosen to generate stubs for each module.
      ListenableFuture<SyncStubReferencesResponse> syncStubReferences(SyncStubReferencesRequest request) 
      SyncStubReferences is called when module stubs have been updated. This allows the plugin to update
references to external modules, regardless of whether they are dependencies.
For example, go plugin adds references to all modules into the go.work file so that tools can automatically
import the modules when users start reference them.
It is optional to do anything with this call.

      • Methods inherited from class io.grpc.stub.AbstractStub

        getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady

      • Methods inherited from class io.grpc.stub.AbstractFutureStub

        newStub

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • buildContextUpdated

         ListenableFuture<BuildContextUpdatedResponse> buildContextUpdated(BuildContextUpdatedRequest request)
        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.
If the plugin will not be able to return a BuildSuccess or BuildFailure, such as when there is no active
build stream, it must fail the BuildContextUpdated call.

      • generateStubs

         ListenableFuture<GenerateStubsResponse> generateStubs(GenerateStubsRequest request)
        Generate stubs for a module.
Stubs allow modules to import other module's exported interface. If a language does not need this step,
then it is not required to do anything in this call.
This call is not tied to the module that this plugin is responsible for. A plugin of each language will
be chosen to generate stubs for each module.

      • syncStubReferences

         ListenableFuture<SyncStubReferencesResponse> syncStubReferences(SyncStubReferencesRequest request)
        SyncStubReferences is called when module stubs have been updated. This allows the plugin to update
references to external modules, regardless of whether they are dependencies.
For example, go plugin adds references to all modules into the go.work file so that tools can automatically
import the modules when users start reference them.
It is optional to do anything with this call.