Package com.vmware.nsx_policy.model

Class RenderConfiguration

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
    public final class RenderConfiguration
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    Render configuration to be applied to the widget.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected com.vmware.vapi.data.StructValue __dynamicStructureFields  

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        RenderConfiguration()
      Default constructor.
      protected RenderConfiguration​(com.vmware.vapi.data.StructValue __dynamicStructureFields)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      <T extends com.vmware.vapi.bindings.Structure>
      T      		 _convertTo​(java.lang.Class<T> clazz)  
      java.lang.String _getCanonicalName()  
      static java.lang.String _getCanonicalTypeName()
      Returns the canonical type name.
      static com.vmware.vapi.bindings.type.StructType _getClassType()
      WARNING: Internal method, subject to change in future versions.
      com.vmware.vapi.data.StructValue _getDataValue()  
      com.vmware.vapi.data.DataValue _getDynamicField​(java.lang.String fieldName)  
      java.util.Set<java.lang.String> _getDynamicFieldNames()  
      com.vmware.vapi.bindings.type.StructType _getType()  
      boolean _hasTypeNameOf​(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)  
      static RenderConfiguration _newInstance​(com.vmware.vapi.data.StructValue structValue)
      WARNING: Internal method, subject to change in future versions.
      Returns new instance of this binding class and injects the provided data value.
      WARNING: The returned object is not fully initialized.
      static RenderConfiguration _newInstance2​(com.vmware.vapi.data.StructValue structValue)
      WARNING: Internal method, subject to change in future versions.
      Serves as a versioning mechanism.
      void _setDynamicField​(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)  
      protected void _updateDataValue​(com.vmware.vapi.data.StructValue structValue)  
      void _validate()  
      boolean equals​(java.lang.Object obj)  
      java.lang.String getColor()
      The color to use when rendering an entity.
      java.lang.String getCondition()
      If the condition is met then the rendering specified for the condition will be applied.
      java.lang.String getDisplayValue()
      If specified, overrides the field value.
      java.util.List<Icon> getIcons()
      Icons to be applied at dashboard for widgets and UI elements.
      java.util.List<Tooltip> getTooltip()
      Multi-line text to be shown on tooltip while hovering over the UI element if the condition is met.
      int hashCode()  
      void setColor​(java.lang.String color)
      The color to use when rendering an entity.
      void setCondition​(java.lang.String condition)
      If the condition is met then the rendering specified for the condition will be applied.
      void setDisplayValue​(java.lang.String displayValue)
      If specified, overrides the field value.
      void setIcons​(java.util.List<Icon> icons)
      Icons to be applied at dashboard for widgets and UI elements.
      void setTooltip​(java.util.List<Tooltip> tooltip)
      Multi-line text to be shown on tooltip while hovering over the UI element if the condition is met.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • __dynamicStructureFields

        protected com.vmware.vapi.data.StructValue __dynamicStructureFields

    • Constructor Detail

      • RenderConfiguration

        public RenderConfiguration()
        Default constructor.

      • RenderConfiguration

        protected RenderConfiguration​(com.vmware.vapi.data.StructValue __dynamicStructureFields)

    • Method Detail

      • getColor

        public java.lang.String getColor()
        The color to use when rendering an entity. For example, set color as 'RED' to render a portion of donut in red.
        Returns:
        The current value of the property.

      • setColor

        public void setColor​(java.lang.String color)
        The color to use when rendering an entity. For example, set color as 'RED' to render a portion of donut in red.
        Parameters:
        color - New value for the property.

      • getCondition

        public java.lang.String getCondition()
        If the condition is met then the rendering specified for the condition will be applied. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.
        Returns:
        The current value of the property.

      • setCondition

        public void setCondition​(java.lang.String condition)
        If the condition is met then the rendering specified for the condition will be applied. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.
        Parameters:
        condition - New value for the property.

      • getDisplayValue

        public java.lang.String getDisplayValue()
        If specified, overrides the field value. This can be used to display a meaningful value in situations where field value is not available or not configured.
        Returns:
        The current value of the property.

      • setDisplayValue

        public void setDisplayValue​(java.lang.String displayValue)
        If specified, overrides the field value. This can be used to display a meaningful value in situations where field value is not available or not configured.
        Parameters:
        displayValue - New value for the property.

      • getIcons

        public java.util.List<Icon> getIcons()
        Icons to be applied at dashboard for widgets and UI elements.
        Returns:
        The current value of the property.

      • setIcons

        public void setIcons​(java.util.List<Icon> icons)
        Icons to be applied at dashboard for widgets and UI elements.
        Parameters:
        icons - New value for the property.

      • getTooltip

        public java.util.List<Tooltip> getTooltip()
        Multi-line text to be shown on tooltip while hovering over the UI element if the condition is met.
        Returns:
        The current value of the property.

      • setTooltip

        public void setTooltip​(java.util.List<Tooltip> tooltip)
        Multi-line text to be shown on tooltip while hovering over the UI element if the condition is met.
        Parameters:
        tooltip - New value for the property.

      • _getType

        public com.vmware.vapi.bindings.type.StructType _getType()
        Specified by:
        _getType in interface com.vmware.vapi.bindings.StaticStructure

      • _getDataValue

        public com.vmware.vapi.data.StructValue _getDataValue()
        Specified by:
        _getDataValue in interface com.vmware.vapi.bindings.Structure

      • _updateDataValue

        protected void _updateDataValue​(com.vmware.vapi.data.StructValue structValue)

      • _validate

        public void _validate()
        Specified by:
        _validate in interface com.vmware.vapi.bindings.StaticStructure

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Specified by:
        toString in interface com.vmware.vapi.bindings.StaticStructure
        Overrides:
        toString in class java.lang.Object

      • _hasTypeNameOf

        public boolean _hasTypeNameOf​(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
        Specified by:
        _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure

      • _convertTo

        public <T extends com.vmware.vapi.bindings.Structure> T _convertTo​(java.lang.Class<T> clazz)
        Specified by:
        _convertTo in interface com.vmware.vapi.bindings.Structure

      • _setDynamicField

        public void _setDynamicField​(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
        Specified by:
        _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure

      • _getDynamicField

        public com.vmware.vapi.data.DataValue _getDynamicField​(java.lang.String fieldName)
        Specified by:
        _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure

      • _getDynamicFieldNames

        public java.util.Set<java.lang.String> _getDynamicFieldNames()
        Specified by:
        _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure

      • _getClassType

        public static com.vmware.vapi.bindings.type.StructType _getClassType()
        WARNING: Internal method, subject to change in future versions.
        Returns:
        StructType instance representing the static bindings type for this Structure.

      • _getCanonicalName

        public java.lang.String _getCanonicalName()
        Specified by:
        _getCanonicalName in interface com.vmware.vapi.bindings.Structure

      • _getCanonicalTypeName

        public static java.lang.String _getCanonicalTypeName()
        Returns the canonical type name. See _getCanonicalName().
        Returns:
        canonical type name

      • _newInstance

        public static RenderConfiguration _newInstance​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Returns new instance of this binding class and injects the provided data value.
        WARNING: The returned object is not fully initialized.
        Parameters:
        structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
        Returns:
        the static bindings StructType

      • _newInstance2

        public static RenderConfiguration _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.