Interface SubnetOpDataEntry

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<SubnetOpDataEntry>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<SubnetOpData>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<SubnetOpDataEntryKey>, NetworkAttributes

    @Generated("mdsal-binding-generator")
    public interface SubnetOpDataEntry
    extends org.opendaylight.yangtools.yang.binding.ChildOf<SubnetOpData>, org.opendaylight.yangtools.yang.binding.Augmentable<SubnetOpDataEntry>, NetworkAttributes, org.opendaylight.yangtools.yang.binding.Identifiable<SubnetOpDataEntryKey>

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

     list subnet-op-data-entry {
       key subnet-id;
       leaf subnet-id {
         type yang:uuid;
       }
       leaf nh-dpnId {
         type uint64;
       }
       leaf vpn-name {
         type string;
       }
       leaf vrf-id {
         type string;
       }
       leaf subnet-cidr {
         type string;
       }
       leaf route-adv-state {
         type task-state;
       }
       leaf last-adv-state {
         type task-state;
       }
       leaf elan-tag {
         type uint32;
       }
       list subnet-to-dpn {
         key dpnId;
         leaf dpnId {
           type uint64;
         }
         list vpn-interfaces {
           key interface-name;
           leaf interface-name {
             type string;
           }
         }
       }
       leaf label {
         type uint32;
       }
       leaf l3vni {
         type uint32;
       }
       uses nvpn:network-attributes;
     }
     
    The schema path to identify an instance is odl-l3vpn/subnet-op-data/subnet-op-data-entry

    To create instances of this class use SubnetOpDataEntryBuilder.

    See Also:
    SubnetOpDataEntryBuilder, SubnetOpDataEntryKey
    • Field Detail

      • QNAME

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

      • implementedInterface

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

        static int bindingHashCode​(@NonNull SubnetOpDataEntry 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 SubnetOpDataEntry 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 SubnetOpDataEntry 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
      • 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.
             
                 UUID representing the subnet 
             
         
        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.
      • getNhDpnId

        org.opendaylight.yangtools.yang.common.Uint64 getNhDpnId()
        Return nhDpnId, or null if it is not present.
             
                 DpnId for the DPN used as nexthop for this subnet
             
         
        Returns:
        org.opendaylight.yangtools.yang.common.Uint64 nhDpnId, or null if it is not present.
      • getVpnName

        java.lang.String getVpnName()
        Return vpnName, or null if it is not present.
             
                 VPN Instance name
             
         
        Returns:
        java.lang.String vpnName, or null if it is not present.
      • getVrfId

        java.lang.String getVrfId()
        Return vrfId, or null if it is not present.
        Returns:
        java.lang.String vrfId, or null if it is not present.
      • getSubnetCidr

        java.lang.String getSubnetCidr()
        Return subnetCidr, or null if it is not present.
             
                 Subnet in cidr notation
             
         
        Returns:
        java.lang.String subnetCidr, or null if it is not present.
      • getRouteAdvState

        TaskState getRouteAdvState()
        Return routeAdvState, or null if it is not present.
             
                 The status of the subnet route advertisement/withdrawal
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.TaskState routeAdvState, or null if it is not present.
      • getLastAdvState

        TaskState getLastAdvState()
        Return lastAdvState, or null if it is not present.
             
                 The previous status of the subnet route advertisement/withdrawal.
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.TaskState lastAdvState, or null if it is not present.
      • getElanTag

        org.opendaylight.yangtools.yang.common.Uint32 getElanTag()
        Return elanTag, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 elanTag, or null if it is not present.
      • getSubnetToDpn

        @Nullable java.util.Map<SubnetToDpnKey,​SubnetToDpn> getSubnetToDpn()
        Return subnetToDpn, or null if it is not present.
        Returns:
        java.util.Map subnetToDpn, or null if it is not present.
      • nonnullSubnetToDpn

        default @NonNull java.util.Map<SubnetToDpnKey,​SubnetToDpn> nonnullSubnetToDpn()
        Return subnetToDpn, or an empty list if it is not present.
        Returns:
        java.util.Map subnetToDpn, or an empty list if it is not present.
      • getLabel

        org.opendaylight.yangtools.yang.common.Uint32 getLabel()
        Return label, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 label, or null if it is not present.
      • getL3vni

        org.opendaylight.yangtools.yang.common.Uint32 getL3vni()
        Return l3vni, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 l3vni, or null if it is not present.