Package com.vmware.nsx_policy.model

Class DonutPart

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
    public final class DonutPart
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    Represents an entity or portion to be plotted on a donut or stats chart.
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  DonutPart.Builder
      Builder class for DonutPart.

    • Field Summary

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

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        DonutPart()
      Default constructor.
      protected DonutPart​(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 DonutPart _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 DonutPart _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 getCondition()
      If the condition is met then the part will be displayed.
      java.lang.String getDrilldownId()
      Id of drilldown widget, if any.
      java.lang.String getField()
      A numerical value that represents the portion or entity of the donut or stats chart.
      java.lang.Boolean getHideEmptyLegend()
      If true, legend will be shown only if the data for the part is available.
      Label getLabel()  
      java.lang.String getNavigation()
      Hyperlink of the specified UI page that provides details.
      java.util.List<RenderConfiguration> getRenderConfiguration()
      Additional rendering or conditional evaluation of the field values to be performed, if any.
      java.util.List<Tooltip> getTooltip()
      Multi-line text to be shown on tooltip while hovering over the portion.
      int hashCode()  
      void setCondition​(java.lang.String condition)
      If the condition is met then the part will be displayed.
      void setDrilldownId​(java.lang.String drilldownId)
      Id of drilldown widget, if any.
      void setField​(java.lang.String field)
      A numerical value that represents the portion or entity of the donut or stats chart.
      void setHideEmptyLegend​(java.lang.Boolean hideEmptyLegend)
      If true, legend will be shown only if the data for the part is available.
      void setLabel​(Label label)  
      void setNavigation​(java.lang.String navigation)
      Hyperlink of the specified UI page that provides details.
      void setRenderConfiguration​(java.util.List<RenderConfiguration> renderConfiguration)
      Additional rendering or conditional evaluation of the field values to be performed, if any.
      void setTooltip​(java.util.List<Tooltip> tooltip)
      Multi-line text to be shown on tooltip while hovering over the portion.
      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

      • DonutPart

        public DonutPart()
        Default constructor.

      • DonutPart

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

    • Method Detail

      • getCondition

        public java.lang.String getCondition()
        If the condition is met then the part will be displayed. 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 part will be displayed. Examples of expression syntax are provided under 'example_request' section of 'CreateWidgetConfiguration' API.
        Parameters:
        condition - New value for the property.

      • getDrilldownId

        public java.lang.String getDrilldownId()
        Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.
        Returns:
        The current value of the property.

      • setDrilldownId

        public void setDrilldownId​(java.lang.String drilldownId)
        Id of drilldown widget, if any. Id should be a valid id of an existing widget. A widget is considered as drilldown widget when it is associated with any other widget and provides more detailed information about any data item from the parent widget.
        Parameters:
        drilldownId - New value for the property.

      • getField

        public java.lang.String getField()
        A numerical value that represents the portion or entity of the donut or stats chart.
        Returns:
        The current value of the property.

      • setField

        public void setField​(java.lang.String field)
        A numerical value that represents the portion or entity of the donut or stats chart.
        Parameters:
        field - New value for the property.

      • getHideEmptyLegend

        public java.lang.Boolean getHideEmptyLegend()
        If true, legend will be shown only if the data for the part is available. This is applicable only if legends are specified in widget configuration.
        Returns:
        The current value of the property.

      • setHideEmptyLegend

        public void setHideEmptyLegend​(java.lang.Boolean hideEmptyLegend)
        If true, legend will be shown only if the data for the part is available. This is applicable only if legends are specified in widget configuration.
        Parameters:
        hideEmptyLegend - New value for the property.

      • getLabel

        public Label getLabel()
        Returns:
        The current value of the property.

      • setLabel

        public void setLabel​(Label label)
        Parameters:
        label - New value for the property.

      • getNavigation

        public java.lang.String getNavigation()
        Hyperlink of the specified UI page that provides details. If drilldown_id is provided, then navigation cannot be used.
        Returns:
        The current value of the property.

      • setNavigation

        public void setNavigation​(java.lang.String navigation)
        Hyperlink of the specified UI page that provides details. If drilldown_id is provided, then navigation cannot be used.
        Parameters:
        navigation - New value for the property.

      • getRenderConfiguration

        public java.util.List<RenderConfiguration> getRenderConfiguration()
        Additional rendering or conditional evaluation of the field values to be performed, if any.
        Returns:
        The current value of the property.

      • setRenderConfiguration

        public void setRenderConfiguration​(java.util.List<RenderConfiguration> renderConfiguration)
        Additional rendering or conditional evaluation of the field values to be performed, if any.
        Parameters:
        renderConfiguration - New value for the property.

      • getTooltip

        public java.util.List<Tooltip> getTooltip()
        Multi-line text to be shown on tooltip while hovering over the portion.
        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 portion.
        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 DonutPart _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 DonutPart _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.