com.streamsets.pipeline.api.Constraint Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2023 StreamSets Inc.
*
* 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;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* A ValueConstraint indicates subsets of possible values of option settings depending on value of another setting.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Constraint {
/**
* The name of the configuration setting that constraints possible values for target setting.
*
* It uses the same rules to reference properties in different classes applied in {@link Dependency}.
*/
String constraintSetting();
/**
* The value of the configuration setting that constraints possible values for target setting.
*/
String constraintValue();
/**
* List of allowed values when constraintSetting and constraintValue have the specified values.
*
* Only one of either permittedValues or prohibitedValues can be specified.
*/
String[] permittedValues() default {};
/**
* List of forbidden values when constraintSetting and constraintValue have the specified values.
*
* Only one of either permittedValues or prohibitedValues can be specified.
*/
String[] prohibitedValues() default {};
}