Package com.vmware.nsx_policy.model

Class NsxTDNSForwarderStatus

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
    public final class NsxTDNSForwarderStatus
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    The current runtime status of the DNS forwarder.
    See Also:
    Serialized Form

    • 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 NsxTDNSForwarderStatus _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 NsxTDNSForwarderStatus _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 getEnforcementPointPath()
      Policy path referencing the enforcement point from where the status is fetched.
      java.lang.String getExtraMessage()
      Extra message, if available This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      java.lang.String getResourceType()
      Possible values are: DNSForwarderStatusPerEnforcementPoint.RESOURCE_TYPE_NSXTDNSFORWARDERSTATUS The value of this property is automatically populated to "NsxTDNSForwarderStatus".
      java.lang.String getStatus()
      Possible values are: STATUS_UP STATUS_DOWN STATUS_ERROR STATUS_NO_BACKUP STATUS_UNKNOWN UP means the DNS forwarder is working correctly on the active transport node and the stand-by transport node (if present).
      java.lang.Long getTimestamp()
      Time stamp of the current status, in ms format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      int hashCode()  
      void setEnforcementPointPath​(java.lang.String enforcementPointPath)
      Policy path referencing the enforcement point from where the status is fetched.
      void setExtraMessage​(java.lang.String extraMessage)
      Extra message, if available This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      void setStatus​(java.lang.String status)
      Possible values are: STATUS_UP STATUS_DOWN STATUS_ERROR STATUS_NO_BACKUP STATUS_UNKNOWN UP means the DNS forwarder is working correctly on the active transport node and the stand-by transport node (if present).
      void setTimestamp​(java.lang.Long timestamp)
      Time stamp of the current status, in ms format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • _TYPE_IDENTIFIER

        public static final java.lang.String _TYPE_IDENTIFIER
        Identifier denoting this class, when it is used in polymorphic context.

        This value should be assigned to the property which is used to discriminate the actual type used in the polymorphic context.

        See Also:
        Constant Field Values

      • STATUS_NO_BACKUP

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

      • __dynamicStructureFields

        protected com.vmware.vapi.data.StructValue __dynamicStructureFields

    • Constructor Detail

      • NsxTDNSForwarderStatus

        public NsxTDNSForwarderStatus()
        Default constructor.

      • NsxTDNSForwarderStatus

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

    • Method Detail

      • getExtraMessage

        public java.lang.String getExtraMessage()
        Extra message, if available This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setExtraMessage

        public void setExtraMessage​(java.lang.String extraMessage)
        Extra message, if available This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        extraMessage - New value for the property.

      • getStatus

        public java.lang.String getStatus()
        Possible values are: UP means the DNS forwarder is working correctly on the active transport node and the stand-by transport node (if present). Failover will occur if either node goes down. DOWN means the DNS forwarder is down on both active transport node and standby node (if present). The DNS forwarder does not function in this situation. Error means there is some error on one or both transport node, or no status was reported from one or both transport nodes. The DNS forwarder may be working (or not working). NO_BACKUP means DNS forwarder is working in only one transport node, either because it is down on the standby node, or no standby is configured. An forwarder outage will occur if the active node goes down. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setStatus

        public void setStatus​(java.lang.String status)
        Possible values are: UP means the DNS forwarder is working correctly on the active transport node and the stand-by transport node (if present). Failover will occur if either node goes down. DOWN means the DNS forwarder is down on both active transport node and standby node (if present). The DNS forwarder does not function in this situation. Error means there is some error on one or both transport node, or no status was reported from one or both transport nodes. The DNS forwarder may be working (or not working). NO_BACKUP means DNS forwarder is working in only one transport node, either because it is down on the standby node, or no standby is configured. An forwarder outage will occur if the active node goes down. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        status - New value for the property.

      • getTimestamp

        public java.lang.Long getTimestamp()
        Time stamp of the current status, in ms format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setTimestamp

        public void setTimestamp​(java.lang.Long timestamp)
        Time stamp of the current status, in ms format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        timestamp - New value for the property.

      • getEnforcementPointPath

        public java.lang.String getEnforcementPointPath()
        Policy path referencing the enforcement point from where the status is fetched. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setEnforcementPointPath

        public void setEnforcementPointPath​(java.lang.String enforcementPointPath)
        Policy path referencing the enforcement point from where the status is fetched. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        enforcementPointPath - 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 NsxTDNSForwarderStatus _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 NsxTDNSForwarderStatus _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.