001/**
002 * Copyright (C) 2006-2025 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.")
031public @interface FixedSchema {
032
033    String value() default "";
034
035    /**
036     * The flows to apply the fixed schema.
037     * With an Input component, it will always concern the main flow. So you can omit it.
038     * With an Output component, it will concern the main, reject and/or any other flow.
039     * In Studio, the main flow's value is "__default__".
040     *
041     * @return the flows concerned by fixed schema. Default to none.
042     */
043    String[] flows() default {};
044
045}