com.streamsets.pipeline.api.ext.json.JsonRuleParameter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of streamsets-datacollector-api Show documentation

StreamSets Data Collector API

The newest version!

/*
 * Copyright contributors to the StreamSets project
 * StreamSets Inc., an IBM Company 2024
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.streamsets.pipeline.api.ext.json;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * {@link JsonDelegate use specific keywords for necessary parameters to run. Through rule parametrs, you provide aliases
 * to these parameters so that different attributes using the same delegat can specify different values for these
 * parameters;
 */
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface JsonRuleParameter {

  /**
   *
   * @return the name of the parameter used by the delegate.
   */
  String name();

  /**
   *
   * @return the name of the parameter passed through runtime parameters.
   */
  String key();

}