Package com.vmware.nsx_policy.model

Class Legend

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
    public final class Legend
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    Represents legend that describes the entities of the widget.
    See Also:
    Serialized Form

    • Field Detail

      • ALIGNMENT_HORIZONTAL

        public static final java.lang.String ALIGNMENT_HORIZONTAL
        See Also:
        Constant Field Values

      • ALIGNMENT_VERTICAL

        public static final java.lang.String ALIGNMENT_VERTICAL
        See Also:
        Constant Field Values

      • DISPLAY_MODE_ALL_LEGENDS

        public static final java.lang.String DISPLAY_MODE_ALL_LEGENDS
        See Also:
        Constant Field Values

      • DISPLAY_MODE_MIN_NO_OF_LEGENDS

        public static final java.lang.String DISPLAY_MODE_MIN_NO_OF_LEGENDS
        See Also:
        Constant Field Values

      • DISPLAY_MODE_OTHER_GROUP_WITH_LEGENDS

        public static final java.lang.String DISPLAY_MODE_OTHER_GROUP_WITH_LEGENDS
        See Also:
        Constant Field Values

      • POSITION_TOP_RIGHT

        public static final java.lang.String POSITION_TOP_RIGHT
        See Also:
        Constant Field Values

      • __dynamicStructureFields

        protected com.vmware.vapi.data.StructValue __dynamicStructureFields

    • Constructor Detail

      • Legend

        public Legend()
        Default constructor.

      • Legend

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

    • Method Detail

      • getAlignment

        public java.lang.String getAlignment()
        Possible values are: Describes the alignment of legend. Alignment of a legend denotes how individual items of the legend are aligned in a container. For example, if VERTICAL is chosen then the items of the legend will appear one below the other and if HORIZONTAL is chosen then the items will appear side by side.
        Returns:
        The current value of the property.

      • setAlignment

        public void setAlignment​(java.lang.String alignment)
        Possible values are: Describes the alignment of legend. Alignment of a legend denotes how individual items of the legend are aligned in a container. For example, if VERTICAL is chosen then the items of the legend will appear one below the other and if HORIZONTAL is chosen then the items will appear side by side.
        Parameters:
        alignment - New value for the property.

      • getDisplayCount

        public java.lang.Boolean getDisplayCount()
        If set to true, it will display the counts in legend. If set to false, counts of entities are not displayed in the legend.
        Returns:
        The current value of the property.

      • setDisplayCount

        public void setDisplayCount​(java.lang.Boolean displayCount)
        If set to true, it will display the counts in legend. If set to false, counts of entities are not displayed in the legend.
        Parameters:
        displayCount - New value for the property.

      • getFilterable

        public java.lang.Boolean getFilterable()
        Show checkbox along with legends if value is set to true. Widget filtering capability can be enable based on legend checkbox selection. for 'display_mode' SHOW_OTHER_GROUP_WITH_LEGENDS filterable property is not supported.
        Returns:
        The current value of the property.

      • setFilterable

        public void setFilterable​(java.lang.Boolean filterable)
        Show checkbox along with legends if value is set to true. Widget filtering capability can be enable based on legend checkbox selection. for 'display_mode' SHOW_OTHER_GROUP_WITH_LEGENDS filterable property is not supported.
        Parameters:
        filterable - New value for the property.

      • getMinLegendsDisplayCount

        public java.lang.Long getMinLegendsDisplayCount()
        A minimum number of legends to be displayed upfront. if 'display_mode' is set to SHOW_MIN_NO_OF_LEGENDS then this property value will be used to display number of legends upfront in the UI. format: int32
        Returns:
        The current value of the property.

      • setMinLegendsDisplayCount

        public void setMinLegendsDisplayCount​(java.lang.Long minLegendsDisplayCount)
        A minimum number of legends to be displayed upfront. if 'display_mode' is set to SHOW_MIN_NO_OF_LEGENDS then this property value will be used to display number of legends upfront in the UI. format: int32
        Parameters:
        minLegendsDisplayCount - New value for the property.

      • getOtherGroupLegendLabel

        public java.lang.String getOtherGroupLegendLabel()
        A translated label for showing other category label in legends.
        Returns:
        The current value of the property.

      • setOtherGroupLegendLabel

        public void setOtherGroupLegendLabel​(java.lang.String otherGroupLegendLabel)
        A translated label for showing other category label in legends.
        Parameters:
        otherGroupLegendLabel - New value for the property.

      • getPosition

        public java.lang.String getPosition()
        Possible values are: Describes the relative placement of legend. The legend of a widget can be placed either to the TOP or BOTTOM or LEFT or RIGHT relative to the widget. For example, if RIGHT is chosen then legend is placed to the right of the widget.
        Returns:
        The current value of the property.

      • setPosition

        public void setPosition​(java.lang.String position)
        Possible values are: Describes the relative placement of legend. The legend of a widget can be placed either to the TOP or BOTTOM or LEFT or RIGHT relative to the widget. For example, if RIGHT is chosen then legend is placed to the right of the widget.
        Parameters:
        position - New value for the property.

      • getType

        public java.lang.String getType()
        Possible values are: Describes the render type for the legend. The legend for an entity describes the entity in the widget. The supported legend type is a circle against which the entity's details such as display_name are shown. The color of the circle denotes the color of the entity shown inside the widget.
        Returns:
        The current value of the property.

      • setType

        public void setType​(java.lang.String type)
        Possible values are: Describes the render type for the legend. The legend for an entity describes the entity in the widget. The supported legend type is a circle against which the entity's details such as display_name are shown. The color of the circle denotes the color of the entity shown inside the widget.
        Parameters:
        type - New value for the property.

      • getUnit

        public java.lang.String getUnit()
        Show unit of entities in the legend.
        Returns:
        The current value of the property.

      • setUnit

        public void setUnit​(java.lang.String unit)
        Show unit of entities in the legend.
        Parameters:
        unit - 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 Legend _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 Legend _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.