001/** 002 * Copyright (C) 2006-2024 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.discovery; 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.service.ActionType; 026 027/** 028 * Mark a method as returning the {@link DiscoverDatasetResult} of a datastore. The only configuration 029 * parameter must be annotated with @DataStore. 030 */ 031@ActionType(value = "discoverdataset", expectedReturnedType = DiscoverDatasetResult.class) 032@Target(METHOD) 033@Retention(RUNTIME) 034@Documentation("This class marks an action that explore a connection to retrieve potential datasets.") 035public @interface DiscoverDataset { 036 037 /** 038 * @return the value of the component family this action relates to. 039 */ 040 String family() default ""; 041 042 /** 043 * @return the name of this update action. 044 */ 045 String value() default "default"; 046 047}