001/**
002 * Copyright (C) 2006-2026 Talend Inc. - www.talend.com
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.talend.sdk.component.api.service.schema;
017
018import static java.lang.annotation.ElementType.TYPE;
019import static java.lang.annotation.RetentionPolicy.RUNTIME;
020
021import java.lang.annotation.Retention;
022import java.lang.annotation.Target;
023
024import org.talend.sdk.component.api.meta.Documentation;
025
026@Target(TYPE)
027@Retention(RUNTIME)
028@Documentation("Mark a connector as having a fixed schema. " +
029        "Annotation's value must match the name of a DiscoverSchema or a DiscoverSchemaExtended annotation. " +
030        "The related action will return the fixed schema for the specified flows. " +
031        "Use watch() to declare parameter paths whose changes should trigger a schema refresh at design time.")
032public @interface FixedSchema {
033
034    String value() default "";
035
036    /**
037     * The flows to apply the fixed schema.
038     * With an Input component, it will always concern the main flow. So you can omit it.
039     * With an Output component, it will concern the main, reject and/or any other flow.
040     * In Studio, the main flow's value is "__default__".
041     *
042     * @return the flows concerned by fixed schema. Default to none.
043     */
044    String[] flows() default {};
045
046    /**
047     * The parameter paths to watch for changes at design time. When any of the listed parameters
048     * changes, the associated {@code DiscoverSchema} or {@code DiscoverSchemaExtended} service
049     * will be re-invoked to refresh the fixed schema dynamically.
050     * <p>
051     * Uses the same relative-path syntax as {@code @Updatable.parameters()}: for example,
052     * {@code "configuration/someParam"} refers to a child parameter of the component configuration root,
053     * and {@code "../sibling"} refers to a sibling parameter.
054     * <p>
055     * Requires {@link #value()} to be set.
056     *
057     * @return the parameter paths to watch. Default to none.
058     */
059    String[] watch() default {};
060
061}