com.streamsets.pipeline.api.HideConfigs Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2017 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;
/**
* Annotation to hide stage configurations in the UI.
*
* Useful to hide/disable built in configurations fields, preconditions and on error record; as well as user defined
* configurations when sub-classing stages to perform specialized tasks.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface HideConfigs {
/**
* Hides system defined 'required fields' and preconditions configurations from the UI.
*/
boolean preconditions() default false;
/**
* Hides system defined 'on error record' configuration from the UI.
*/
boolean onErrorRecord() default false;
/**
* Hides the specified user defined configurations from the UI.
*
* When first character in configuration to exclude is / (slash), this configuration will be treated as a regular
* expression. All setting whose qualified name matches this regular expression will be hidden. Still, an exception
* will be raised if no configuration matches this regular expression.
*/
String[] value() default {};
}