com.streamsets.pipeline.api.CompositeConfigDef Maven / Gradle / Ivy
/*
* Copyright 2023 StreamSets Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.streamsets.pipeline.api;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
*
* A composed config is an artifact for the UI to show, in read-only form, multiple configs as a single one.
* For example, a composed config would display [database].[schema].[table] where database, schema and table
* are 3 different configs. When trying to edit the composed config the UI would show the 3 separate configs
* to edit.
*
*
* It must be used on instance variables of type Void in the stage config or config beans.
*
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface CompositeConfigDef {
/**
*
* The default label for the UI.
*
*/
String label();
/**
*
* The default tooltip description for the UI.
*
*/
String description() default "";
/**
*
* The configuration group for the UI.
*
*
* If the configuration variable is within a configuration bean, instead hardcoding the group name it is possible
* to reference the group ordinal (using #N where N is the ordinal) of the groups defined in
* {@link ConfigDefBean} annotation of the configuration bean variable.
*
* @see ConfigDefBean
*/
String group() default "";
/**
*
* The display position in the UI.
*
*/
int displayPosition() default 0;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
@interface Config {
/**
*
* Config name. It is possible to use ^ as prefix or postfix to refer to other configs by location.
*
*/
String name();
/**
*
* Separator to use before the next config, default is an empty space.
*
*/
String separator() default "";
}
/**
*
* Configs, in display order, used to compose the display value.
*
*/
Config[] configs();
}