Package com.vmware.nsx_policy.model

Class PropertyItem

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
    public final class PropertyItem
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    Represents a label-value pair.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        PropertyItem()
      Default constructor.
      protected PropertyItem​(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 PropertyItem _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 PropertyItem _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 property will be displayed.
      java.lang.String getDrilldownId()
      Id of drilldown widget, if any.
      java.lang.String getField()
      Represents field value of the property.
      java.lang.Boolean getHeading()
      Set to true if the field is a heading.
      Label getLabel()  
      java.lang.String getLabelValueSeparator()
      Label value separator used between label and value.
      java.lang.String getNavigation()
      Hyperlink of the specified UI page that provides details.
      java.util.List<RenderConfiguration> getRenderConfiguration()
      Render configuration to be applied, if any.
      java.lang.Long getRowspan()
      Represent the vertical span of the widget / container format: int32
      java.lang.Boolean getSeparator()
      If true, separates this property in a widget.
      java.lang.Long getSpan()
      Represent the horizontal span of the widget / container.
      com.vmware.vapi.bindings.Structure getStyle()
      A style object applicable for the property item.
      java.lang.String getType()
      Possible values are: TYPE_STRING TYPE_NUMBER TYPE_DATE TYPE_URL Data type of the field.
      int hashCode()  
      void setCondition​(java.lang.String condition)
      If the condition is met then the property will be displayed.
      void setDrilldownId​(java.lang.String drilldownId)
      Id of drilldown widget, if any.
      void setField​(java.lang.String field)
      Represents field value of the property.
      void setHeading​(java.lang.Boolean heading)
      Set to true if the field is a heading.
      void setLabel​(Label label)  
      void setLabelValueSeparator​(java.lang.String labelValueSeparator)
      Label value separator used between label and value.
      void setNavigation​(java.lang.String navigation)
      Hyperlink of the specified UI page that provides details.
      void setRenderConfiguration​(java.util.List<RenderConfiguration> renderConfiguration)
      Render configuration to be applied, if any.
      void setRowspan​(java.lang.Long rowspan)
      Represent the vertical span of the widget / container format: int32
      void setSeparator​(java.lang.Boolean separator)
      If true, separates this property in a widget.
      void setSpan​(java.lang.Long span)
      Represent the horizontal span of the widget / container.
      void setStyle​(com.vmware.vapi.bindings.Structure style)
      A style object applicable for the property item.
      void setType​(java.lang.String type)
      Possible values are: TYPE_STRING TYPE_NUMBER TYPE_DATE TYPE_URL Data type of the field.
      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

      • PropertyItem

        public PropertyItem()
        Default constructor.

      • PropertyItem

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

    • Method Detail

      • getCondition

        public java.lang.String getCondition()
        If the condition is met then the property 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 property 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()
        Represents field value of the property.
        Returns:
        The current value of the property.

      • setField

        public void setField​(java.lang.String field)
        Represents field value of the property.
        Parameters:
        field - New value for the property.

      • getHeading

        public java.lang.Boolean getHeading()
        Set to true if the field is a heading. Default is false.
        Returns:
        The current value of the property.

      • setHeading

        public void setHeading​(java.lang.Boolean heading)
        Set to true if the field is a heading. Default is false.
        Parameters:
        heading - 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.

      • getLabelValueSeparator

        public java.lang.String getLabelValueSeparator()
        Label value separator used between label and value. It can be any separator like \":\" or \"-\".
        Returns:
        The current value of the property.

      • setLabelValueSeparator

        public void setLabelValueSeparator​(java.lang.String labelValueSeparator)
        Label value separator used between label and value. It can be any separator like \":\" or \"-\".
        Parameters:
        labelValueSeparator - New value for the property.

      • getNavigation

        public java.lang.String getNavigation()
        Hyperlink of the specified UI page that provides details. This will be linked with value of the property.
        Returns:
        The current value of the property.

      • setNavigation

        public void setNavigation​(java.lang.String navigation)
        Hyperlink of the specified UI page that provides details. This will be linked with value of the property.
        Parameters:
        navigation - New value for the property.

      • getRenderConfiguration

        public java.util.List<RenderConfiguration> getRenderConfiguration()
        Render configuration to be applied, if any.
        Returns:
        The current value of the property.

      • setRenderConfiguration

        public void setRenderConfiguration​(java.util.List<RenderConfiguration> renderConfiguration)
        Render configuration to be applied, if any.
        Parameters:
        renderConfiguration - New value for the property.

      • getRowspan

        public java.lang.Long getRowspan()
        Represent the vertical span of the widget / container format: int32
        Returns:
        The current value of the property.

      • setRowspan

        public void setRowspan​(java.lang.Long rowspan)
        Represent the vertical span of the widget / container format: int32
        Parameters:
        rowspan - New value for the property.

      • getSeparator

        public java.lang.Boolean getSeparator()
        If true, separates this property in a widget.
        Returns:
        The current value of the property.

      • setSeparator

        public void setSeparator​(java.lang.Boolean separator)
        If true, separates this property in a widget.
        Parameters:
        separator - New value for the property.

      • getSpan

        public java.lang.Long getSpan()
        Represent the horizontal span of the widget / container. format: int32
        Returns:
        The current value of the property.

      • setSpan

        public void setSpan​(java.lang.Long span)
        Represent the horizontal span of the widget / container. format: int32
        Parameters:
        span - New value for the property.

      • getStyle

        public com.vmware.vapi.bindings.Structure getStyle()
        A style object applicable for the property item. It could be the any padding, margin style sheet applicable to the property item. A 'style' property is supported in case of layout 'AUTO' only.
        Returns:
        The current value of the property.

      • setStyle

        public void setStyle​(com.vmware.vapi.bindings.Structure style)
        A style object applicable for the property item. It could be the any padding, margin style sheet applicable to the property item. A 'style' property is supported in case of layout 'AUTO' only.
        Parameters:
        style - 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 PropertyItem _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 PropertyItem _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.