Interface Adjacency

  • All Superinterfaces:
    AdjacencyOpData, org.opendaylight.yangtools.yang.binding.Augmentable<Adjacency>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<AdjacencyList>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<AdjacencyKey>

    @Generated("mdsal-binding-generator")
    public interface Adjacency
    extends org.opendaylight.yangtools.yang.binding.ChildOf<AdjacencyList>, org.opendaylight.yangtools.yang.binding.Augmentable<Adjacency>, AdjacencyOpData, org.opendaylight.yangtools.yang.binding.Identifiable<AdjacencyKey>

    This class represents the following YANG schema fragment defined in module l3vpn-instances-interfaces

     list adjacency {
       key ip_address;
       leaf-list next-hop-ip-list {
         type string;
       }
       leaf ip_address {
         type string;
       }
       leaf adjacency_type {
         type enumeration {
           enum primary-adjacency {
             value 1;
           }
           enum learnt-ip {
             value 2;
           }
           enum extra-route {
             value 3;
           }
         }
         default extra-route;
       }
       leaf mac_address {
         type string;
       }
       leaf subnet_id {
         type yang:uuid;
       }
       leaf subnet_gateway_ip {
         type string;
       }
       leaf phys-network-func {
         type boolean;
         default false;
       }
       uses adjacency-op-data;
     }
     
    The schema path to identify an instance is l3vpn-instances-interfaces/adjacency-list/adjacency

    To create instances of this class use AdjacencyBuilder.

    See Also:
    AdjacencyBuilder, AdjacencyKey
    • Field Detail

      • QNAME

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

      • implementedInterface

        default java.lang.Class<Adjacency> implementedInterface()
        Specified by:
        implementedInterface in interface AdjacencyOpData
        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 Adjacency 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 Adjacency 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 Adjacency 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
      • getNextHopIpList

        @Nullable java.util.List<java.lang.String> getNextHopIpList()
        Return nextHopIpList, or null if it is not present.
        Returns:
        java.util.List nextHopIpList, or null if it is not present.
      • getIpAddress

        java.lang.String getIpAddress()
        Return ipAddress, or null if it is not present.
        Returns:
        java.lang.String ipAddress, or null if it is not present.
      • getAdjacencyType

        Adjacency.AdjacencyType getAdjacencyType()
        Return adjacencyType, or null if it is not present.
             
                 The type of adjacency
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.adjacency.list.Adjacency.AdjacencyType adjacencyType, or null if it is not present.
      • getMacAddress

        java.lang.String getMacAddress()
        Return macAddress, or null if it is not present.
        Returns:
        java.lang.String macAddress, or null if it is not present.
      • getSubnetId

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getSubnetId()
        Return subnetId, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid subnetId, or null if it is not present.
      • getSubnetGatewayIp

        java.lang.String getSubnetGatewayIp()
        Return subnetGatewayIp, or null if it is not present.
        Returns:
        java.lang.String subnetGatewayIp, or null if it is not present.
      • getPhysNetworkFunc

        java.lang.Boolean getPhysNetworkFunc()
        Return physNetworkFunc, or null if it is not present.
             
                 Value of True indicates this is an adjacency of a device in a provider network
             
         
        Returns:
        java.lang.Boolean physNetworkFunc, or null if it is not present.
      • isPhysNetworkFunc

        @Deprecated(forRemoval=true)
        default java.lang.Boolean isPhysNetworkFunc()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • key

        AdjacencyKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<AdjacencyKey>