类的使用
org.apache.seatunnel.api.configuration.Option

使用Option的程序包

程序包	说明
org.apache.seatunnel.api.common
org.apache.seatunnel.api.configuration
org.apache.seatunnel.api.configuration.util
org.apache.seatunnel.api.env
org.apache.seatunnel.api.sink
org.apache.seatunnel.api.source
org.apache.seatunnel.api.table.catalog
org.apache.seatunnel.api.table.catalog.schema

org.apache.seatunnel.api.common中Option的使用

声明为Option的org.apache.seatunnel.api.common中的字段

限定符和类型	字段和说明
static Option<Integer>	CommonOptions.PARALLELISM
static Option<String>	CommonOptions.PLUGIN_NAME
static Option<String>	CommonOptions.RESULT_TABLE_NAME
static Option<List<String>>	CommonOptions.SOURCE_TABLE_NAME

org.apache.seatunnel.api.configuration中Option的使用

org.apache.seatunnel.api.configuration中Option的子类

限定符和类型	类和说明
class	SingleChoiceOption<T>

返回Option的org.apache.seatunnel.api.configuration中的方法

限定符和类型	方法和说明
Option<T>	Options.TypedOptionBuilder.defaultValue(T value) Creates a Option with the given default value.
Option<T>	Options.TypedOptionBuilder.noDefaultValue() Creates a Option without a default value.
Option<T>	Option.withDescription(String description)
Option<T>	Option.withFallbackKeys(String... fallbackKeys)

参数类型为Option的org.apache.seatunnel.api.configuration中的方法

限定符和类型	方法和说明
<T> T	ReadonlyConfig.get(Option<T> option)
<T> Optional<T>	ReadonlyConfig.getOptional(Option<T> option)

org.apache.seatunnel.api.configuration.util中Option的使用

返回Option的org.apache.seatunnel.api.configuration.util中的方法

限定符和类型	方法和说明
Option<T>	Condition.getOption()

返回变量类型为Option的类型的org.apache.seatunnel.api.configuration.util中的方法

限定符和类型	方法和说明
List<Option<?>>	OptionRule.getOptionalOptions()
List<Option<?>>	RequiredOption.getOptions()
List<Option<?>>	RequiredOption.ExclusiveRequiredOptions.getOptions()
List<Option<?>>	RequiredOption.AbsolutelyRequiredOptions.getOptions()
List<Option<?>>	RequiredOption.ConditionalRequiredOptions.getOptions()
List<Option<?>>	RequiredOption.BundledRequiredOptions.getOptions()
static List<Option<?>>	OptionUtil.getOptions(Class<?> clazz)
List<Option<?>>	RequiredOption.ConditionalRequiredOptions.getRequiredOption()
List<Option<?>>	RequiredOption.BundledRequiredOptions.getRequiredOption()

参数类型为Option的org.apache.seatunnel.api.configuration.util中的方法

限定符和类型	方法和说明
<E> Condition<T>	Condition.and(Option<E> option, E expectValue)
OptionRule.Builder	OptionRule.Builder.bundled(Option<?>... requiredOptions) Bundled options, must be present or absent together.
<T> OptionRule.Builder	OptionRule.Builder.conditional(@NonNull Option<T> conditionalOption, @NonNull List<T> expectValues, Option<?>... requiredOptions)
<T> OptionRule.Builder	OptionRule.Builder.conditional(@NonNull Option<T> conditionalOption, @NonNull List<T> expectValues, Option<?>... requiredOptions)
<T> OptionRule.Builder	OptionRule.Builder.conditional(@NonNull Option<T> conditionalOption, T expectValue, Option<?>... requiredOptions)
<T> OptionRule.Builder	OptionRule.Builder.conditional(@NonNull Option<T> conditionalOption, T expectValue, Option<?>... requiredOptions)
static <T> T	ConfigUtil.convertValue(Object rawValue, Option<T> option)
OptionRule.Builder	OptionRule.Builder.exclusive(Option<?>... options) Exclusive options, only one of the options needs to be configured.
static RequiredOption.ExclusiveRequiredOptions	RequiredOption.ExclusiveRequiredOptions.of(Option<?>... options)
static RequiredOption.AbsolutelyRequiredOptions	RequiredOption.AbsolutelyRequiredOptions.of(Option<?>... requiredOption)
static RequiredOption.BundledRequiredOptions	RequiredOption.BundledRequiredOptions.of(Option<?>... requiredOption)
static <T> Expression	Expression.of(Option<T> option, T expectValue)
static <T> Condition<T>	Condition.of(Option<T> option, T expectValue)
OptionRule.Builder	OptionRule.Builder.optional(Option<?>... options) Optional options This options will not be validated.
<E> Condition<T>	Condition.or(Option<E> option, E expectValue)
OptionRule.Builder	OptionRule.Builder.required(Option<?>... options) Absolutely required options without any constraints.

类型变量类型为Option的org.apache.seatunnel.api.configuration.util中的方法参数

限定符和类型	方法和说明
static String	OptionUtil.getOptionKeys(List<Option<?>> options)
static String	OptionUtil.getOptionKeys(List<Option<?>> options, List<RequiredOption.BundledRequiredOptions> bundledOptions)
static RequiredOption.ConditionalRequiredOptions	RequiredOption.ConditionalRequiredOptions.of(Condition<?> condition, List<Option<?>> requiredOption)
static RequiredOption.ConditionalRequiredOptions	RequiredOption.ConditionalRequiredOptions.of(Expression expression, List<Option<?>> requiredOption)
static RequiredOption.BundledRequiredOptions	RequiredOption.BundledRequiredOptions.of(List<Option<?>> requiredOption)

参数类型为Option的org.apache.seatunnel.api.configuration.util中的构造器

构造器和说明
OptionValidationException(Option<?> option)

org.apache.seatunnel.api.env中Option的使用

声明为Option的org.apache.seatunnel.api.env中的字段

限定符和类型	字段和说明
static Option<Long>	EnvCommonOptions.CHECKPOINT_INTERVAL
static Option<Long>	EnvCommonOptions.CHECKPOINT_TIMEOUT
static Option<Map<String,String>>	EnvCommonOptions.CUSTOM_PARAMETERS
static Option<String>	EnvCommonOptions.JARS
static Option<JobMode>	EnvCommonOptions.JOB_MODE
static Option<String>	EnvCommonOptions.JOB_NAME
static Option<Integer>	EnvCommonOptions.PARALLELISM
static Option<Integer>	EnvCommonOptions.READ_LIMIT_BYTES_PER_SECOND
static Option<Integer>	EnvCommonOptions.READ_LIMIT_ROW_PER_SECOND

org.apache.seatunnel.api.sink中Option的使用

声明为Option的org.apache.seatunnel.api.sink中的字段

限定符和类型	字段和说明
static Option<Integer>	SinkCommonOptions.MULTI_TABLE_SINK_REPLICA

org.apache.seatunnel.api.source中Option的使用

声明为Option的org.apache.seatunnel.api.source中的字段

限定符和类型	字段和说明
static Option<ParsingMode>	SourceOptions.DAG_PARSING_MODE

org.apache.seatunnel.api.table.catalog中Option的使用

声明为Option的org.apache.seatunnel.api.table.catalog中的字段

限定符和类型	字段和说明
static Option<Map<String,String>>	CatalogOptions.CATALOG_OPTIONS 已过时。
static Option<String>	CatalogOptions.DATABASE_PATTERN
static Option<String>	CatalogOptions.NAME
static Option<List<String>>	CatalogOptions.TABLE_NAMES
static Option<String>	CatalogOptions.TABLE_PATTERN

org.apache.seatunnel.api.table.catalog.schema中Option的使用

声明为Option的org.apache.seatunnel.api.table.catalog.schema中的字段

限定符和类型	字段和说明
static Option<Integer>	TableSchemaOptions.ColumnOptions.COLUMN_LENGTH
static Option<List<Map<String,Object>>>	TableSchemaOptions.ColumnOptions.COLUMNS
static Option<String>	TableSchemaOptions.TableIdentifierOptions.COMMENT
static Option<String>	TableSchemaOptions.ColumnOptions.COMMENT
static Option<String>	TableSchemaOptions.ConstraintKeyOptions.CONSTRAINT_KEY_COLUMN_NAME
static Option<ConstraintKey.ColumnSortType>	TableSchemaOptions.ConstraintKeyOptions.CONSTRAINT_KEY_COLUMN_SORT_TYPE
static Option<List<Map<String,Object>>>	TableSchemaOptions.ConstraintKeyOptions.CONSTRAINT_KEY_COLUMNS
static Option<String>	TableSchemaOptions.ConstraintKeyOptions.CONSTRAINT_KEY_NAME
static Option<ConstraintKey.ConstraintType>	TableSchemaOptions.ConstraintKeyOptions.CONSTRAINT_KEY_TYPE
static Option<List<Map<String,Object>>>	TableSchemaOptions.ConstraintKeyOptions.CONSTRAINT_KEYS
static Option<Object>	TableSchemaOptions.ColumnOptions.DEFAULT_VALUE
static Option<Map<String,Object>>	TableSchemaOptions.FieldOptions.FIELDS 已过时。
static Option<String>	TableSchemaOptions.ColumnOptions.NAME
static Option<Boolean>	TableSchemaOptions.ColumnOptions.NULLABLE
static Option<Map<String,Object>>	TableSchemaOptions.PrimaryKeyOptions.PRIMARY_KEY
static Option<List<String>>	TableSchemaOptions.PrimaryKeyOptions.PRIMARY_KEY_COLUMNS
static Option<String>	TableSchemaOptions.PrimaryKeyOptions.PRIMARY_KEY_NAME
static Option<Map<String,Object>>	TableSchemaOptions.SCHEMA
static Option<Boolean>	TableSchemaOptions.TableIdentifierOptions.SCHEMA_FIRST
static Option<String>	TableSchemaOptions.TableIdentifierOptions.TABLE
static Option<String>	TableSchemaOptions.ColumnOptions.TYPE