Package com.vmware.aria.operations.definition

Class StringParameterBuilder

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final String getLabel() Label that is displayed in the VMware Aria Operations UI.
      final Unit setLabel(String label) Label that is displayed in the VMware Aria Operations UI.
      final String getDescription() More in-depth explanation of the parameter.
      final Unit setDescription(String description) More in-depth explanation of the parameter.
      final String getDefault() The default value of the parameter.
      final Unit setDefault(String default) The default value of the parameter.
      final Integer getMaxLength() The max length of the parameter value, defaults to 512.
      final Unit setMaxLength(Integer maxLength) The max length of the parameter value, defaults to 512.
      final Boolean getRequired() True if user is required to provide this parameter.
      final Unit setRequired(Boolean required) True if user is required to provide this parameter.
      final Boolean getAdvanced() True if the parameter should be collapsed by default.
      final Unit setAdvanced(Boolean advanced) True if the parameter should be collapsed by default.
      final String getKey() Used to identify the parameter.
      final StringParameter build(Integer dashboardOrder)

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • StringParameterBuilder

        StringParameterBuilder(String key)

    • Method Detail

      • getLabel

         final String getLabel()

        Label that is displayed in the VMware Aria Operations UI. Defaults to the key.

      • setLabel

         final Unit setLabel(String label)

        Label that is displayed in the VMware Aria Operations UI. Defaults to the key.

      • getDescription

         final String getDescription()

        More in-depth explanation of the parameter. Displayed as a tooltip in the VMware Aria Operations UI.

      • setDescription

         final Unit setDescription(String description)

        More in-depth explanation of the parameter. Displayed as a tooltip in the VMware Aria Operations UI.

      • getDefault

         final String getDefault()

        The default value of the parameter.

      • setDefault

         final Unit setDefault(String default)

        The default value of the parameter.

      • getMaxLength

         final Integer getMaxLength()

        The max length of the parameter value, defaults to 512.

      • setMaxLength

         final Unit setMaxLength(Integer maxLength)

        The max length of the parameter value, defaults to 512.

      • getRequired

         final Boolean getRequired()

        True if user is required to provide this parameter. Defaults to True.

      • setRequired

         final Unit setRequired(Boolean required)

        True if user is required to provide this parameter. Defaults to True.

      • getAdvanced

         final Boolean getAdvanced()

        True if the parameter should be collapsed by default. Defaults to False.

      • setAdvanced

         final Unit setAdvanced(Boolean advanced)

        True if the parameter should be collapsed by default. Defaults to False.

      • getKey

         final String getKey()

        Used to identify the parameter.