001/**
002 * Copyright (C) 2006-2022 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.METHOD;
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;
025import org.talend.sdk.component.api.meta.Partial;
026import org.talend.sdk.component.api.service.ActionType;
027
028/**
029 * Mark a method as retruning the {@link Schema} of a dataset. The only configuration
030 * parameter will be an {@link org.talend.sdk.component.api.configuration.Option} named "dataset".
031 */
032@Partial("See Schema description.")
033@ActionType(value = "schema", expectedReturnedType = org.talend.sdk.component.api.record.Schema.class)
034@Target(METHOD)
035@Retention(RUNTIME)
036@Documentation("Mark an action as returning a discovered schema. Its parameter MUST be a dataset. "
037        + "Dataset is configuration type annotated with @DataSet. "
038        + "If component has multiple datasets, then dataset used as action parameter "
039        + "should have the same identifier as this @DiscoverSchema. ")
040public @interface DiscoverSchema {
041
042    /**
043     * @return the component family this action belongs to.
044     */
045    String family() default "";
046
047    /**
048     * @return the identifier usable by {@link org.talend.sdk.component.api.configuration.ui.widget.Structure}
049     * to reference this action.
050     */
051    String value() default "default";
052}