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.configuration;
017
018import static java.lang.annotation.ElementType.FIELD;
019import static java.lang.annotation.ElementType.PARAMETER;
020import static java.lang.annotation.RetentionPolicy.RUNTIME;
021
022import java.lang.annotation.Retention;
023import java.lang.annotation.Target;
024
025/**
026 * Mark a configuration field (injected in a
027 * {@link org.talend.sdk.component.api.input.Emitter} or {@link org.talend.sdk.component.api.processor.Processor}
028 * method parameter or nested in one of these method parameters).
029 */
030@Target({ FIELD, PARAMETER })
031@Retention(RUNTIME)
032public @interface Option {
033
034    /**
035     * Mark parameter of streaming {@link org.talend.sdk.component.api.input.PartitionMapper}
036     * where {@link org.talend.sdk.component.api.input.PartitionMapper#infinite()} == true and
037     * {@link org.talend.sdk.component.api.input.PartitionMapper#stoppable()} == true
038     * that it contains max duration in milliseconds between start read the value and end
039     * expected type of the parameter is long or int or their boxed equivalents
040     */
041    String MAX_DURATION_PARAMETER = "maxDurationMs";
042
043    /**
044     * Mark parameter of streaming {@link org.talend.sdk.component.api.input.PartitionMapper}
045     * where {@link org.talend.sdk.component.api.input.PartitionMapper#infinite()} == true and
046     * {@link org.talend.sdk.component.api.input.PartitionMapper#stoppable()} == true
047     * that it limits amount of records that connector can read.
048     * expected type of the parameter is long or int or their boxed equivalents
049     */
050    String MAX_RECORDS_PARAMETER = "maxRecords";
051
052    /**
053     * The value of the option, if empty it will use the classname + field value (ex:
054     * {@code com.company.ConfigModel.data}).
055     * 
056     * @return the value of the option.
057     */
058    String value() default "";
059}