Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.connection.points

Interface ConnectionPoint

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<ConnectionPoint>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<ConnectionPoints>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<ConnectionPointKey>
    @Generated("mdsal-binding-generator")
public interface ConnectionPoint
extends org.opendaylight.yangtools.yang.binding.ChildOf<ConnectionPoints>, org.opendaylight.yangtools.yang.binding.Augmentable<ConnectionPoint>, org.opendaylight.yangtools.yang.binding.Identifiable<ConnectionPointKey>
    A connection point within a Layer 2 network instance. Each connection-point consists of a set of interfaces only one of which is active at any one time. Other than the specification of whether an interface is local (i.e., exists within this network-instance), or remote, all configuration and state are common

    This class represents the following YANG schema fragment defined in module openconfig-network-instance 

     list connection-point {
   key connection-point-id;
   leaf connection-point-id {
     type leafref {
       path ../config/connection-point-id;
     }
   }
   container config {
     uses instance-connection-point-config;
   }
   container state {
     config false;
     uses instance-connection-point-config;
     uses instance-connection-point-state;
   }
   container endpoints {
     when "../config/type = 'L2P2P' or ../config/type = 'L2VSI'" {
     }
     list endpoint {
       key endpoint-id;
       leaf endpoint-id {
         type leafref {
           path ../config/endpoint-id;
         }
       }
       container config {
         uses instance-endpoint-config;
       }
       container state {
         config false;
         uses instance-endpoint-config;
         uses instance-endpoint-state;
       }
     }
   }
 }

    To create instances of this class use ConnectionPointBuilder.

    See Also:
    ConnectionPointBuilder, ConnectionPointKey

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
        YANG identifier of the statement represented by this class.

    • Method Detail

      • implementedInterface

        default Class<ConnectionPoint> 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 ConnectionPoint 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:
        NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull ConnectionPoint thisObj,
                             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:
        NullPointerException - if thisObj is null

      • bindingToString

        static String bindingToString​(@NonNull ConnectionPoint 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:
        NullPointerException - if obj is null

      • getConnectionPointId

        String getConnectionPointId()
        Return connectionPointId, or null if it is not present. 
             
         A locally significant reference for the connection-point
        Returns:
        String connectionPointId, or null if it is not present.

      • requireConnectionPointId

        default @NonNull String requireConnectionPointId()
        Return connectionPointId, guaranteed to be non-null. 
             
         A locally significant reference for the connection-point
        Returns:
        String connectionPointId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if connectionPointId is not present

      • getConfig

        Config getConfig()
        Return config, or null if it is not present. 
             
         Configuration parameters relating to a Layer 2 network instance connection point
        Returns:
        Config config, or null if it is not present.

      • getState

        State getState()
        Return state, or null if it is not present. 
             
         Operational state parameters relating to a Layer 2 network instance connection
         point
        Returns:
        State state, or null if it is not present.

      • getEndpoints

        Endpoints getEndpoints()
        Return endpoints, or null if it is not present. 
             
         The set of endpoints which are grouped within the connection point
        Returns:
        Endpoints endpoints, or null if it is not present.