Class BFDProperties

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

    public final class BFDProperties
    extends java.lang.Object
    implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    BFD information
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        BFDProperties()
      Default constructor.
      protected BFDProperties​(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 BFDProperties _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 BFDProperties _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.Boolean getActive()
      True if tunnel is active in a gateway HA setup 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 getBfdEncap()
      Possible values are: BFD_ENCAP_GENEVE BFD_ENCAP_NONE BFD_ENCAP_UNKNOWN_ENCAP The encapsulation type of BFD.
      java.lang.String getDiagnostic()
      A short message indicating what the BFD session thinks is wrong in case of a problem 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.Boolean getForwarding()
      True if the BFD session believes this interface may be used to forward traffic 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 getRemoteDiagnostic()
      A short message indicating what the remote interface's BFD session thinks is wrong in case of a problem 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 getRemoteState()
      Possible values are: REMOTE_STATE_UNKNOWN_STATE REMOTE_STATE_ADMIN_DOWN REMOTE_STATE_DOWN REMOTE_STATE_INIT REMOTE_STATE_UP State of the remote interface's BFD session 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 getState()
      Possible values are: STATE_UNKNOWN_STATE STATE_ADMIN_DOWN STATE_DOWN STATE_INIT STATE_UP State of the BFD session 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 setActive​(java.lang.Boolean active)
      True if tunnel is active in a gateway HA setup 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 setBfdEncap​(java.lang.String bfdEncap)
      Possible values are: BFD_ENCAP_GENEVE BFD_ENCAP_NONE BFD_ENCAP_UNKNOWN_ENCAP The encapsulation type of BFD.
      void setDiagnostic​(java.lang.String diagnostic)
      A short message indicating what the BFD session thinks is wrong in case of a problem 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 setForwarding​(java.lang.Boolean forwarding)
      True if the BFD session believes this interface may be used to forward traffic 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 setRemoteDiagnostic​(java.lang.String remoteDiagnostic)
      A short message indicating what the remote interface's BFD session thinks is wrong in case of a problem 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 setRemoteState​(java.lang.String remoteState)
      Possible values are: REMOTE_STATE_UNKNOWN_STATE REMOTE_STATE_ADMIN_DOWN REMOTE_STATE_DOWN REMOTE_STATE_INIT REMOTE_STATE_UP State of the remote interface's BFD session 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 setState​(java.lang.String state)
      Possible values are: STATE_UNKNOWN_STATE STATE_ADMIN_DOWN STATE_DOWN STATE_INIT STATE_UP State of the BFD session 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

      • BFD_ENCAP_GENEVE

        public static final java.lang.String BFD_ENCAP_GENEVE
        See Also:
        Constant Field Values
      • BFD_ENCAP_UNKNOWN_ENCAP

        public static final java.lang.String BFD_ENCAP_UNKNOWN_ENCAP
        See Also:
        Constant Field Values
      • REMOTE_STATE_UNKNOWN_STATE

        public static final java.lang.String REMOTE_STATE_UNKNOWN_STATE
        See Also:
        Constant Field Values
      • REMOTE_STATE_ADMIN_DOWN

        public static final java.lang.String REMOTE_STATE_ADMIN_DOWN
        See Also:
        Constant Field Values
      • REMOTE_STATE_DOWN

        public static final java.lang.String REMOTE_STATE_DOWN
        See Also:
        Constant Field Values
      • REMOTE_STATE_INIT

        public static final java.lang.String REMOTE_STATE_INIT
        See Also:
        Constant Field Values
      • STATE_UNKNOWN_STATE

        public static final java.lang.String STATE_UNKNOWN_STATE
        See Also:
        Constant Field Values
      • STATE_ADMIN_DOWN

        public static final java.lang.String STATE_ADMIN_DOWN
        See Also:
        Constant Field Values
      • __dynamicStructureFields

        protected com.vmware.vapi.data.StructValue __dynamicStructureFields
    • Constructor Detail

      • BFDProperties

        public BFDProperties()
        Default constructor.
      • BFDProperties

        protected BFDProperties​(com.vmware.vapi.data.StructValue __dynamicStructureFields)
    • Method Detail

      • getActive

        public java.lang.Boolean getActive()
        True if tunnel is active in a gateway HA setup 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.
      • setActive

        public void setActive​(java.lang.Boolean active)
        True if tunnel is active in a gateway HA setup 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:
        active - New value for the property.
      • getBfdEncap

        public java.lang.String getBfdEncap()
        Possible values are: The encapsulation type of BFD. GENEVE - BFD with GENEVE encapsulation NONE - BFD with no encapsulation UNKNOWN_ENCAP - BFD with unknown encapsulation
        Returns:
        The current value of the property.
      • setBfdEncap

        public void setBfdEncap​(java.lang.String bfdEncap)
        Possible values are: The encapsulation type of BFD. GENEVE - BFD with GENEVE encapsulation NONE - BFD with no encapsulation UNKNOWN_ENCAP - BFD with unknown encapsulation
        Parameters:
        bfdEncap - New value for the property.
      • getDiagnostic

        public java.lang.String getDiagnostic()
        A short message indicating what the BFD session thinks is wrong in case of a problem 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.
      • setDiagnostic

        public void setDiagnostic​(java.lang.String diagnostic)
        A short message indicating what the BFD session thinks is wrong in case of a problem 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:
        diagnostic - New value for the property.
      • getForwarding

        public java.lang.Boolean getForwarding()
        True if the BFD session believes this interface may be used to forward traffic 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.
      • setForwarding

        public void setForwarding​(java.lang.Boolean forwarding)
        True if the BFD session believes this interface may be used to forward traffic 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:
        forwarding - New value for the property.
      • getRemoteDiagnostic

        public java.lang.String getRemoteDiagnostic()
        A short message indicating what the remote interface's BFD session thinks is wrong in case of a problem 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.
      • setRemoteDiagnostic

        public void setRemoteDiagnostic​(java.lang.String remoteDiagnostic)
        A short message indicating what the remote interface's BFD session thinks is wrong in case of a problem 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:
        remoteDiagnostic - New value for the property.
      • getState

        public java.lang.String getState()
        Possible values are: State of the BFD session 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.
      • setState

        public void setState​(java.lang.String state)
        Possible values are: State of the BFD session 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:
        state - 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 BFDProperties _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 BFDProperties _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.