Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ElementRequiredDescription
nameYesThe name of the configuration parameter.
descriptionYesThe description of the configuration parameter.
labelNoThe user friendly name of the configuration parameter (used in the Ambari Administration Interface UI).
placeholderNoThe placeholder value for the configuration parameter (used in the Ambari Administration Interface UI).
default-valueNoThe default value for the configuration parameter (used in the Ambari Administration Interface UI).
requiredYesIf true, the configuration parameter is required in order to create a view instance.
maskedNoIndicated this parameter value is to be "masked" in the Ambari Web UI (i.e. not shown in the clear). Omitting this element default to not-masked. Otherwise, if true, the parameter value will be "masked" in the Web UI.
Code Block
<parameter>
    <name>someParameter</name>
    <description>Some parameter this is used to configure an instance of this view</description>
    <required>false</required>
</parameter>

See the Property View Example to see the different parameter options in use.

Anchor
view.permission
view.permission
<permission>

...

Code Block
<view-class>this.is.my.viewclazz</view-class>

Anchor
view.validator-class
view.validator-class
<validator-class>

Registers a validator class to receive property and instance validation requests. The validator class must implement the Validator interface.

Code Block
 <validator-class>org.apache.ambari.view.property.MyValidator</validator-class>

See Property Validator View Example to see view property and instance validation in use.