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.ModuleConfigDefaultsResponseOrBuilder


public final class ModuleConfigDefaultsResponse
extends GeneratedMessageV3 implements ModuleConfigDefaultsResponseOrBuilder

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.

Protobuf type xyz.block.ftl.language.v1.ModuleConfigDefaultsResponse

Nested Class Summary

Modifier and Type Class Description

public final class

ModuleConfigDefaultsResponse.Builder

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.

Protobuf type xyz.block.ftl.language.v1.ModuleConfigDefaultsResponse

Field Summary

Fields
Modifier and Type	Field	Description
`public final static int`	`DEPLOY_DIR_FIELD_NUMBER`
`public final static int`	`BUILD_FIELD_NUMBER`
`public final static int`	`DEV_MODE_BUILD_FIELD_NUMBER`
`public final static int`	`BUILD_LOCK_FIELD_NUMBER`
`public final static int`	`WATCH_FIELD_NUMBER`
`public final static int`	`LANGUAGE_CONFIG_FIELD_NUMBER`
`public final static int`	`SQL_MIGRATION_DIR_FIELD_NUMBER`
`public final static int`	`SQL_QUERY_DIR_FIELD_NUMBER`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final static Descriptors.Descriptor`	`getDescriptor()`
`String`	`getDeployDir()`	`Default relative path to the directory containing all build artifacts for deployments` `string deploy_dir = 1;`
`ByteString`	`getDeployDirBytes()`	`Default relative path to the directory containing all build artifacts for deployments` `string deploy_dir = 1;`
`boolean`	`hasBuild()`	`Default build command` `optional string build = 2;`
`String`	`getBuild()`	`Default build command` `optional string build = 2;`
`ByteString`	`getBuildBytes()`	`Default build command` `optional string build = 2;`
`boolean`	`hasDevModeBuild()`	`Dev mode build command, if different from the regular build command` `optional string dev_mode_build = 3;`
`String`	`getDevModeBuild()`	`Dev mode build command, if different from the regular build command` `optional string dev_mode_build = 3;`
`ByteString`	`getDevModeBuildBytes()`	`Dev mode build command, if different from the regular build command` `optional string dev_mode_build = 3;`
`boolean`	`hasBuildLock()`	`Build lock path to prevent concurrent builds` `optional string build_lock = 4;`
`String`	`getBuildLock()`	`Build lock path to prevent concurrent builds` `optional string build_lock = 4;`
`ByteString`	`getBuildLockBytes()`	`Build lock path to prevent concurrent builds` `optional string build_lock = 4;`
`ProtocolStringList`	`getWatchList()`	`Default patterns to watch for file changes, relative to the module directory` `repeated string watch = 6;`
`int`	`getWatchCount()`	`Default patterns to watch for file changes, relative to the module directory` `repeated string watch = 6;`
`String`	`getWatch(int index)`	`Default patterns to watch for file changes, relative to the module directory` `repeated string watch = 6;`
`ByteString`	`getWatchBytes(int index)`	`Default patterns to watch for file changes, relative to the module directory` `repeated string watch = 6;`
`boolean`	`hasLanguageConfig()`	`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.` `.google.protobuf.Struct language_config = 7;`
`Struct`	`getLanguageConfig()`	`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.` `.google.protobuf.Struct language_config = 7;`
`StructOrBuilder`	`getLanguageConfigOrBuilder()`	`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.` `.google.protobuf.Struct language_config = 7;`
`String`	`getSqlMigrationDir()`	`Default directory containing the SQL migration files` `string sql_migration_dir = 8;`
`ByteString`	`getSqlMigrationDirBytes()`	`Default directory containing the SQL migration files` `string sql_migration_dir = 8;`
`String`	`getSqlQueryDir()`	`Default directory containing the SQL query files` `string sql_query_dir = 9;`
`ByteString`	`getSqlQueryDirBytes()`	`Default directory containing the SQL query files` `string sql_query_dir = 9;`
`final boolean`	`isInitialized()`
`void`	`writeTo(CodedOutputStream output)`
`int`	`getSerializedSize()`
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`static ModuleConfigDefaultsResponse`	`parseFrom(ByteBuffer data)`
`static ModuleConfigDefaultsResponse`	`parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static ModuleConfigDefaultsResponse`	`parseFrom(ByteString data)`
`static ModuleConfigDefaultsResponse`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static ModuleConfigDefaultsResponse`	`parseFrom(Array<byte> data)`
`static ModuleConfigDefaultsResponse`	`parseFrom(Array<byte> data, ExtensionRegistryLite extensionRegistry)`
`static ModuleConfigDefaultsResponse`	`parseFrom(InputStream input)`
`static ModuleConfigDefaultsResponse`	`parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static ModuleConfigDefaultsResponse`	`parseDelimitedFrom(InputStream input)`
`static ModuleConfigDefaultsResponse`	`parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static ModuleConfigDefaultsResponse`	`parseFrom(CodedInputStream input)`
`static ModuleConfigDefaultsResponse`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`ModuleConfigDefaultsResponse.Builder`	`newBuilderForType()`
`static ModuleConfigDefaultsResponse.Builder`	`newBuilder()`
`static ModuleConfigDefaultsResponse.Builder`	`newBuilder(ModuleConfigDefaultsResponse prototype)`
`ModuleConfigDefaultsResponse.Builder`	`toBuilder()`
`static ModuleConfigDefaultsResponse`	`getDefaultInstance()`
`static Parser<ModuleConfigDefaultsResponse>`	`parser()`
`Parser<ModuleConfigDefaultsResponse>`	`getParserForType()`
`ModuleConfigDefaultsResponse`	`getDefaultInstanceForType()`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
toByteArray, toByteString, writeDelimitedTo
Methods inherited from class com.google.protobuf.Message
getParserForType
Methods inherited from class com.google.protobuf.MessageLite
getParserForType
Methods inherited from class com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Method Detail

getDescriptor

 final static Descriptors.Descriptor getDescriptor()

getDeployDir

 String getDeployDir()

Default relative path to the directory containing all build artifacts for deployments

string deploy_dir = 1;

Returns:: The deployDir.

getDeployDirBytes

 ByteString getDeployDirBytes()

Default relative path to the directory containing all build artifacts for deployments

string deploy_dir = 1;

Returns:: The bytes for deployDir.

hasBuild
```
 boolean hasBuild()
```
```
Default build command
```
optional string build = 2;
Returns:

Whether the build field is set.

getBuild
```
 String getBuild()
```
```
Default build command
```
optional string build = 2;
Returns:

The build.

getBuildBytes
```
 ByteString getBuildBytes()
```
```
Default build command
```
optional string build = 2;
Returns:

The bytes for build.

hasDevModeBuild

 boolean hasDevModeBuild()

Dev mode build command, if different from the regular build command

optional string dev_mode_build = 3;

Returns:: Whether the devModeBuild field is set.

getDevModeBuild

 String getDevModeBuild()

Dev mode build command, if different from the regular build command

optional string dev_mode_build = 3;

Returns:: The devModeBuild.

getDevModeBuildBytes

 ByteString getDevModeBuildBytes()

Dev mode build command, if different from the regular build command

optional string dev_mode_build = 3;

Returns:: The bytes for devModeBuild.

hasBuildLock
```
 boolean hasBuildLock()
```
```
Build lock path to prevent concurrent builds
```
optional string build_lock = 4;
Returns:

Whether the buildLock field is set.

getBuildLock

 String getBuildLock()

Build lock path to prevent concurrent builds

optional string build_lock = 4;

Returns:: The buildLock.

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

The bytes for buildLock.

getWatchList

 ProtocolStringList getWatchList()

Default patterns to watch for file changes, relative to the module directory

repeated string watch = 6;

Returns:: A list containing the watch.

getWatchCount

 int getWatchCount()

Default patterns to watch for file changes, relative to the module directory

repeated string watch = 6;

Returns:: The count of watch.

getWatch
```
 String getWatch(int index)
```
```
Default patterns to watch for file changes, relative to the module directory
```
repeated string watch = 6;
Parameters:

index - The index of the element to return.

Returns:

The watch at the given index.

getWatchBytes
```
 ByteString getWatchBytes(int index)
```
```
Default patterns to watch for file changes, relative to the module directory
```
repeated string watch = 6;
Parameters:

index - The index of the value to return.

Returns:

The bytes of the watch at the given index.

hasLanguageConfig

 boolean hasLanguageConfig()

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.

.google.protobuf.Struct language_config = 7;

Returns:: Whether the languageConfig field is set.

getLanguageConfig

 Struct getLanguageConfig()

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.

.google.protobuf.Struct language_config = 7;

Returns:: The languageConfig.

getLanguageConfigOrBuilder

 StructOrBuilder getLanguageConfigOrBuilder()

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.

.google.protobuf.Struct language_config = 7;

getSqlMigrationDir

 String getSqlMigrationDir()

Default directory containing the SQL migration files

string sql_migration_dir = 8;

Returns:: The sqlMigrationDir.

getSqlMigrationDirBytes

 ByteString getSqlMigrationDirBytes()

Default directory containing the SQL migration files

string sql_migration_dir = 8;

Returns:: The bytes for sqlMigrationDir.

getSqlQueryDir

 String getSqlQueryDir()

Default directory containing the SQL query files

string sql_query_dir = 9;

Returns:: The sqlQueryDir.

getSqlQueryDirBytes

 ByteString getSqlQueryDirBytes()

Default directory containing the SQL query files

string sql_query_dir = 9;

Returns:: The bytes for sqlQueryDir.

isInitialized
```
 final boolean isInitialized()
```

writeTo

 void writeTo(CodedOutputStream output)

getSerializedSize
```
 int getSerializedSize()
```

equals
```
 boolean equals(Object obj)
```

hashCode
```
 int hashCode()
```

parseFrom

 static ModuleConfigDefaultsResponse parseFrom(ByteBuffer data)

parseFrom

 static ModuleConfigDefaultsResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

parseFrom

 static ModuleConfigDefaultsResponse parseFrom(ByteString data)

parseFrom

 static ModuleConfigDefaultsResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

parseFrom

 static ModuleConfigDefaultsResponse parseFrom(Array<byte> data)

parseFrom

 static ModuleConfigDefaultsResponse parseFrom(Array<byte> data, ExtensionRegistryLite extensionRegistry)

parseFrom

 static ModuleConfigDefaultsResponse parseFrom(InputStream input)

parseFrom

 static ModuleConfigDefaultsResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

parseDelimitedFrom

 static ModuleConfigDefaultsResponse parseDelimitedFrom(InputStream input)

parseDelimitedFrom

 static ModuleConfigDefaultsResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom

 static ModuleConfigDefaultsResponse parseFrom(CodedInputStream input)

parseFrom

 static ModuleConfigDefaultsResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

newBuilderForType

 ModuleConfigDefaultsResponse.Builder newBuilderForType()

newBuilder

 static ModuleConfigDefaultsResponse.Builder newBuilder()

newBuilder

 static ModuleConfigDefaultsResponse.Builder newBuilder(ModuleConfigDefaultsResponse prototype)

toBuilder

 ModuleConfigDefaultsResponse.Builder toBuilder()

getDefaultInstance

 static ModuleConfigDefaultsResponse getDefaultInstance()

parser

 static Parser<ModuleConfigDefaultsResponse> parser()

getParserForType

 Parser<ModuleConfigDefaultsResponse> getParserForType()

getDefaultInstanceForType

 ModuleConfigDefaultsResponse getDefaultInstanceForType()

Class ModuleConfigDefaultsResponse

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class com.google.protobuf.Message

Methods inherited from class com.google.protobuf.MessageLite

Methods inherited from class com.google.protobuf.MessageLiteOrBuilder

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

getDescriptor

getDeployDir

getDeployDirBytes

hasBuild

getBuild

getBuildBytes

hasDevModeBuild

getDevModeBuild

getDevModeBuildBytes

hasBuildLock

getBuildLock

getBuildLockBytes

getWatchList

getWatchCount

getWatch

getWatchBytes

hasLanguageConfig

getLanguageConfig

getLanguageConfigOrBuilder

getSqlMigrationDir

getSqlMigrationDirBytes

getSqlQueryDir

getSqlQueryDirBytes

isInitialized

writeTo

getSerializedSize

equals

hashCode

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseDelimitedFrom

parseDelimitedFrom

parseFrom

parseFrom

newBuilderForType

newBuilder

newBuilder

toBuilder

getDefaultInstance

parser

getParserForType

getDefaultInstanceForType