Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states

Interface InterVpnLinkState

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<InterVpnLinkState>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<InterVpnLinkStates>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<InterVpnLinkStateKey>
    @Generated("mdsal-binding-generator")
public interface InterVpnLinkState
extends org.opendaylight.yangtools.yang.binding.ChildOf<InterVpnLinkStates>, org.opendaylight.yangtools.yang.binding.Augmentable<InterVpnLinkState>, org.opendaylight.yangtools.yang.binding.Identifiable<InterVpnLinkStateKey>

    This class represents the following YANG schema fragment defined in module inter-vpn-link 

     list inter-vpn-link-state {
   key inter-vpn-link-name;
   leaf inter-vpn-link-name {
     type string;
   }
   leaf state {
     type enumeration {
       enum active;
       enum error;
     }
   }
   container first-endpoint-state {
     uses vpn-endpoint-state-attribs;
   }
   container second-endpoint-state {
     uses vpn-endpoint-state-attribs;
   }
   leaf error-description {
     type string;
   }
 }
    The schema path to identify an instance is inter-vpn-link/inter-vpn-link-states/inter-vpn-link-state

    To create instances of this class use InterVpnLinkStateBuilder.

    See Also:
    InterVpnLinkStateBuilder, InterVpnLinkStateKey

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

    • Method Detail

      • implementedInterface

        default java.lang.Class<InterVpnLinkState> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • bindingHashCode

        static int bindingHashCode​(@NonNull InterVpnLinkState obj)
        Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
        Parameters:
        obj - Object for which to generate hashCode() result.
        Returns:
        Hash code value of data modeled by this interface.
        Throws:
        java.lang.NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull InterVpnLinkState thisObj,
                             java.lang.Object obj)
        Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
        Parameters:
        thisObj - Object acting as the receiver of equals invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        java.lang.NullPointerException - if thisObj is null

      • bindingToString

        static java.lang.String bindingToString​(@NonNull InterVpnLinkState obj)
        Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
        Parameters:
        obj - Object for which to generate toString() result.
        Returns:
        String value of data modeled by this interface.
        Throws:
        java.lang.NullPointerException - if obj is null

      • getInterVpnLinkName

        java.lang.String getInterVpnLinkName()
        Return interVpnLinkName, or null if it is not present.
        Returns:
        java.lang.String interVpnLinkName, or null if it is not present.

      • getState

        InterVpnLinkState.State getState()
        Return state, or null if it is not present. 
             
         Holds the current state of the InterVPN Link
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.InterVpnLinkState.State state, or null if it is not present.

      • getFirstEndpointState

        FirstEndpointState getFirstEndpointState()
        Return firstEndpointState, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.inter.vpn.link.state.FirstEndpointState firstEndpointState, or null if it is not present.

      • getSecondEndpointState

        SecondEndpointState getSecondEndpointState()
        Return secondEndpointState, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.netvirt.inter.vpn.link.rev160311.inter.vpn.link.states.inter.vpn.link.state.SecondEndpointState secondEndpointState, or null if it is not present.

      • getErrorDescription

        java.lang.String getErrorDescription()
        Return errorDescription, or null if it is not present.
        Returns:
        java.lang.String errorDescription, or null if it is not present.