Class ModuleConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message , com.google.protobuf.MessageLite , com.google.protobuf.MessageLiteOrBuilder , com.google.protobuf.MessageOrBuilder , java.io.Serializable , xyz.block.ftl.language.v1.ModuleConfigOrBuilder

    
    public final class ModuleConfig
    extends GeneratedMessageV3 implements ModuleConfigOrBuilder
                        
    ModuleConfig contains the configuration for a module, found in the module's ftl.toml file.
    
    Protobuf type xyz.block.ftl.language.v1.ModuleConfig
    • Constructor Detail

    • Method Detail

      • getDescriptor

         final static Descriptors.Descriptor getDescriptor()
      • getName

         String getName()
        Name of the module
        
        string name = 1;
        Returns:

        The name.

      • getNameBytes

         ByteString getNameBytes()
        Name of the module
        
        string name = 1;
        Returns:

        The bytes for name.

      • getDir

         String getDir()
        Absolute path to the module's directory
        
        string dir = 2;
        Returns:

        The dir.

      • getDirBytes

         ByteString getDirBytes()
        Absolute path to the module's directory
        
        string dir = 2;
        Returns:

        The bytes for dir.

      • getLanguage

         String getLanguage()
        The language of the module
        
        string language = 3;
        Returns:

        The language.

      • getLanguageBytes

         ByteString getLanguageBytes()
        The language of the module
        
        string language = 3;
        Returns:

        The bytes for language.

      • getDeployDir

         String getDeployDir()
        Absolute path to the directory containing all of this module's build artifacts for deployments
        
        string deploy_dir = 4;
        Returns:

        The deployDir.

      • getDeployDirBytes

         ByteString getDeployDirBytes()
        Absolute path to the directory containing all of this module's build artifacts for deployments
        
        string deploy_dir = 4;
        Returns:

        The bytes for deployDir.

      • hasBuild

         boolean hasBuild()
        Build is the command to build the module.
        
        optional string build = 5;
        Returns:

        Whether the build field is set.

      • getBuild

         String getBuild()
        Build is the command to build the module.
        
        optional string build = 5;
        Returns:

        The build.

      • getBuildBytes

         ByteString getBuildBytes()
        Build is the command to build the module.
        
        optional string build = 5;
        Returns:

        The bytes for build.

      • hasDevModeBuild

         boolean hasDevModeBuild()
        DevModeBuild is the command to build the module in dev mode.
        
        optional string dev_mode_build = 6;
        Returns:

        Whether the devModeBuild field is set.

      • getDevModeBuild

         String getDevModeBuild()
        DevModeBuild is the command to build the module in dev mode.
        
        optional string dev_mode_build = 6;
        Returns:

        The devModeBuild.

      • getDevModeBuildBytes

         ByteString getDevModeBuildBytes()
        DevModeBuild is the command to build the module in dev mode.
        
        optional string dev_mode_build = 6;
        Returns:

        The bytes for devModeBuild.

      • getBuildLock

         String getBuildLock()
        Build lock path to prevent concurrent builds
        
        string build_lock = 7;
        Returns:

        The buildLock.

      • getBuildLockBytes

         ByteString getBuildLockBytes()
        Build lock path to prevent concurrent builds
        
        string build_lock = 7;
        Returns:

        The bytes for buildLock.

      • getWatchList

         ProtocolStringList getWatchList()
        Patterns to watch for file changes
        
        repeated string watch = 9;
        Returns:

        A list containing the watch.

      • getWatchCount

         int getWatchCount()
        Patterns to watch for file changes
        
        repeated string watch = 9;
        Returns:

        The count of watch.

      • getWatch

         String getWatch(int index)
        Patterns to watch for file changes
        
        repeated string watch = 9;
        Parameters:
        index - The index of the element to return.
        Returns:

        The watch at the given index.

      • getWatchBytes

         ByteString getWatchBytes(int index)
        Patterns to watch for file changes
        
        repeated string watch = 9;
        Parameters:
        index - The index of the value to return.
        Returns:

        The bytes of the watch at the given index.

      • hasLanguageConfig

         boolean hasLanguageConfig()
        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")
        
        .google.protobuf.Struct language_config = 10;
        Returns:

        Whether the languageConfig field is set.

      • getLanguageConfig

         Struct getLanguageConfig()
        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")
        
        .google.protobuf.Struct language_config = 10;
        Returns:

        The languageConfig.

      • getLanguageConfigOrBuilder

         StructOrBuilder getLanguageConfigOrBuilder()
        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")
        
        .google.protobuf.Struct language_config = 10;
      • getSqlRootDir

         String getSqlRootDir()
        The root directory containing the SQL files, relative to the module directory.
        
        string sql_root_dir = 11;
        Returns:

        The sqlRootDir.

      • getSqlRootDirBytes

         ByteString getSqlRootDirBytes()
        The root directory containing the SQL files, relative to the module directory.
        
        string sql_root_dir = 11;
        Returns:

        The bytes for sqlRootDir.

      • getRealm

         String getRealm()
        The realm of the module
        
        string realm = 12;
        Returns:

        The realm.

      • getRealmBytes

         ByteString getRealmBytes()
        The realm of the module
        
        string realm = 12;
        Returns:

        The bytes for realm.

      • writeTo

         void writeTo(CodedOutputStream output)
      • parseFrom

         static ModuleConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)